Skip to content

Commit 495c4aa

Browse files
authored
Initial Atom (RSS-like) feed support (alshedivat#284)
* initial Atom (RSS-like) feed support * Update _config.yml
1 parent a5508c7 commit 495c4aa

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ source 'https://rubygems.org'
22
group :jekyll_plugins do
33
gem 'jekyll'
44
gem 'jekyll-email-protect'
5+
gem 'jekyll-feed'
56
gem 'jekyll-github-metadata'
67
gem 'jekyll-paginate-v2'
78
gem 'jekyll-scholar'

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,12 @@ If you have a different question, please ask using [Discussions](https://github.
234234
If you are deploying a project page to GitHub Pages, leave `url` blank and set `baseurl: /<your-project-name>/`.
235235
Generally, if you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`.
236236

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

239245
### Publications
@@ -343,6 +349,10 @@ This can be configured on a per-page basis, by setting the `og_image` page varia
343349
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`.
344350
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.
345351

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

347357
## Contributing
348358

_config.yml

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ baseurl: /al-folio # the subpath of your site, e.g. /blog/
2020
last_updated: false # set to true if you want to display last updated in the footer
2121
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
2222

23+
# -----------------------------------------------------------------------------
24+
# RSS Feed
25+
# -----------------------------------------------------------------------------
26+
# will use title and url fields
27+
# Take a look to https://github.com/jekyll/jekyll-feed for more customization
28+
2329
# -----------------------------------------------------------------------------
2430
# Layout
2531
# -----------------------------------------------------------------------------
@@ -129,6 +135,7 @@ keep_files:
129135
plugins:
130136
- jekyll-email-protect
131137
- jekyll-github-metadata
138+
- jekyll-feed
132139
- jekyll-paginate-v2
133140
- jekyll/scholar
134141
- jekyll-twitter-plugin

0 commit comments

Comments
 (0)