Skip to content

Commit

Permalink
Initial Atom (RSS-like) feed support (alshedivat#284)
Browse files Browse the repository at this point in the history
* initial Atom (RSS-like) feed support

* Update _config.yml
  • Loading branch information
dag7dev authored Jul 5, 2021
1 parent a5508c7 commit 495c4aa
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ source 'https://rubygems.org'
group :jekyll_plugins do
gem 'jekyll'
gem 'jekyll-email-protect'
gem 'jekyll-feed'
gem 'jekyll-github-metadata'
gem 'jekyll-paginate-v2'
gem 'jekyll-scholar'
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,12 @@ If you have a different question, please ask using [Discussions](https://github.
If you are deploying a project page to GitHub Pages, leave `url` blank and set `baseurl: /<your-project-name>/`.
Generally, if you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`.

4. **Q:** Atom feed doesn't work. Why?
<br>
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
RSS Feed plugin works with these correctly set up fields: `title`, `url`, `description` and `author`.
Make sure to fill them in an appropriate way and try again.

## Features

### Publications
Expand Down Expand Up @@ -343,6 +349,10 @@ This can be configured on a per-page basis, by setting the `og_image` page varia
If for an individual page this variable is not set, then the theme will fall back to a site-wide `og_image` variable, configurable in your `_config.yml`.
In both the page-specific and site-wide cases, the `og_image` variable needs to hold the URL for the image you wish to display in social media previews.

#### Atom (RSS-like) Feed
It generates an Atom (RSS-like) feed of your posts, useful for Atom and RSS readers.
The feed is reachable simply by typing after your homepage `/feed.xml`.
E.g. assuming your website mountpoint is the main folder, you can type `yourusername.github.io/feed.xml`

## Contributing

Expand Down
7 changes: 7 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ baseurl: /al-folio # the subpath of your site, e.g. /blog/
last_updated: false # set to true if you want to display last updated in the footer
impressum_path: # set to path to include impressum link in the footer, use the same path as permalink in a page, helps to conform with EU GDPR

# -----------------------------------------------------------------------------
# RSS Feed
# -----------------------------------------------------------------------------
# will use title and url fields
# Take a look to https://github.com/jekyll/jekyll-feed for more customization

# -----------------------------------------------------------------------------
# Layout
# -----------------------------------------------------------------------------
Expand Down Expand Up @@ -129,6 +135,7 @@ keep_files:
plugins:
- jekyll-email-protect
- jekyll-github-metadata
- jekyll-feed
- jekyll-paginate-v2
- jekyll/scholar
- jekyll-twitter-plugin
Expand Down

0 comments on commit 495c4aa

Please sign in to comment.