Use Atom template for feed #24
Conversation
|
So, do you plan to rename the plugin to jekyll-atom-feed too? I still believe offering the 2 is the best solution for Jekyll users. |
Opened #27 to discuss. |
lib/feed.xml
Outdated
There was a problem hiding this comment.
Is the slash after {{ url_base }} necessary?
lib/feed.xml
Outdated
There was a problem hiding this comment.
post.excerpt should be escaped.
Per Atom spec, all text should be escaped.
There was a problem hiding this comment.
I think it would be awesome if Jekyll had one official way of organizing your settings because I think most people fill out their _config.yml with very different ways of handling it. I have a author block that contains my name, email, twitter and so on that you can use via {% site.author.name %} while others use collections for authors and so on. I think we'd benefit from having one central way of doing this so it'd be easier for plugins to have values in common.
|
Thanks all for the feedback. Sounds like we've got a few follow up discussion to tackle in new issues, but things are at least solid enough here to merge, for now, and we can continue to improve the template. |
This pull request updates
/feed.xmlto serve Atom, rather than RSS, per the discussion over in #2.The pull request also updates the documentation, continuing to use the term RSS at times, because as @pathawks noted, although not technically accurate, it is often used a generic term to describe blog feeds. ✨ SEO ✨
The Atom feed validates against W3 with no warnings.
I also wanted to call out a few optional, common site-level and post-level configuration variables, which are baked into the template:
Optional configuration options
The plugin will automatically use any of the following configuration variables, if they are present in your site's
_config.ymlfile.name- The title of the site, e.g., "My awesome site"description- A longer description of what your site is about, e.g., "Where I blog about Jekyll and other awesome things"url- The URL to your site, e.g.,http://example.com. If none is provided, the plugin will try to usesite.github.url.author- Your name, e.g., "Dr. Jekyll"Optional front matter
The plugin will use the following post metadata, automatically generated by Jekyll, which you can override via a post's YAML front matter:
datetitleexcerptidcategorytagsAdditionally, the plugin will use the following values, if present in a post's YAML front matter:
author- The author of the post, e.g., "Dr. Jekyll". If none is given, feed readers will look to the feed author as defined in_config.ymlFixes #2.