Skip to content

Commit

Permalink
Implement RSS 2.0 and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LeNPaul committed Dec 19, 2017
1 parent 5b63dd8 commit 15a087b
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 5 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,17 @@ It is possible to track your site statistics through [Google Analytics](https://

### RSS Feeds

Atom is supported through [Jekyll-Feed](https://github.com/jekyll/jekyll-feed), and RSS 2.0 is supported through [RSS auto-discovery](https://www.rssboard.org/rss-autodiscovery). By default, Lagrange uses the Atom feed.
Atom is supported by default through [jekyll-feed](https://github.com/jekyll/jekyll-feed). With jekyll-feed, you can set configuration variables such as 'title', 'description', and 'author', in the `_config.yml` file.

With Jekyll-Feed (Atom), you can set configuration variables such as `title`, `description`, and `author` in the `_config.yml` file. For RSS 2.0, uncomment the last two lines in the `_config.yml` file to activate RSS auto-discovery. The `rss-feed.xml` file that the feed path points to when using RSS 2.0 automatically uses the appropriate configuration variables found in `_data/settings.yml`.
RSS 2.0 is also supported through [RSS auto-discovery](https://www.rssboard.org/rss-autodiscovery). The `rss-feed.xml` file (based on the template found at [jekyll-rss-feeds](https://github.com/snaptortoise/jekyll-rss-feeds)) that the feed path points to when using RSS 2.0 is automatically generated based on the appropriate configuration variables found in `_data/settings.yml`.

To use RSS 2.0, ensure the following is done:

* Uncomment the last two lines in the `_config.yml` file.

* In `_data/settings.yml`, under 'social', comment out the rss-square that points to `feed.xml`, and uncomment the rss-square that points to `rss-feed.xml`.

* In `_includes/head.html`, comment out `{% feed_meta %}` and uncomment the line under the RSS 2.0 comment.

### Social Media Icons

Expand Down
1 change: 1 addition & 0 deletions _data/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ social:
- {icon: 'instagram', link: 'https://instagram.com/paululele'}
- {icon: 'envelope', link: 'mailto:[email protected]'}
- {icon: 'rss-square', link: 'feed.xml'}
# - {icon: 'rss-square', link: 'rss-feed.xml'}
6 changes: 3 additions & 3 deletions _includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@

<link rel="stylesheet" href="{{ site.github.url }}/assets/css/main.css">
<link rel="stylesheet" href="{{ site.github.url }}/assets/css/syntax.css">
<!-- Use Atom -->
{% feed_meta %}
<!-- RSS-v2.0
<link href="{{ site.github.url }}/feed.xml" type="application/rss+xml" rel="alternate" title="{{ site.data.settings.title }} | {{ site.data.settings.tagline }}"/>
<link href="{{ site.github.url }}/rss-feed.xml" type="application/rss+xml" rel="alternate" title="{{ site.data.settings.title }} | {{ site.data.settings.tagline }}"/>
//-->


Expand All @@ -26,8 +28,6 @@
</script>

{% include google-analytics.html %}
<!-- Use Atom -->
{% feed_meta %}

<!-- Use Jekyll SEO plugin -->
{% seo %}
Expand Down

0 comments on commit 15a087b

Please sign in to comment.