Templates for rendering JSON feeds for your Jekyll blog
Switch branches/tags
Nothing to show
Clone or download
georgemandis Update README.md
Fixed a typo. Added a header.
Latest commit 25fa115 May 23, 2017
Permalink
Failed to load latest commit information.
.gitignore initial commit May 22, 2017
LICENSE.md
README.md Update README.md May 23, 2017
feed.articles.json
feed.category.json initial commit May 22, 2017
feed.json initial commit May 22, 2017
feed.links.json
feed.tag.json initial commit May 22, 2017

README.md

Jekyll JSON Feed Templates

A few Liquid templates to use for rendering JSON feeds for your Jekyll blog in keeping with the JSONFeed spec. Like it's sister project jekyll-rss-feeds, it features a number of kinds of feeds:

  • feed.json — Renders the 10 most recent posts.
  • feed.category.json — Only renders posts for a specific category. This example renders posts for a "miscellaneous" category.
  • feed.tag.json — Only renders posts for a specific tag. This example renders posts for a "jekyll" category.
  • feed.links.json — Only contains posts that link to external websites noted by a link variable in the YAML Front Matter. Not a common Jekyll convention, but a good way to generating a linked list.
  • feed.articles.json — Only showing articles that don't link to external sites; The opposite of feed.links.json

How to use

  • Update _config.yml as noted below, or manually replace the variables.
  • Copy one of the JSON (ie, feed.json) files to the root directory of your Jekyll blog.
  • Run jekyll.

In your generated _site folder you should find a properly formatted feed at feed.json.

Customizing _config.yml

These templates rely on a customized version of _config.yml. The following lines have been added:

name: Your Blog's Name
description: A description for your blog
url: http://your-blog-url.example.com

author: Your Name (optional)

This makes it easy to reference the title, description and URL for your site in the feed templates using {{ site.name }}, {{ site.description }} and {{ site.url }}. Even if you're not using these feed templates, you might find these variables useful when you're designing your layouts.

Looking for the RSS version?

If you missed the link at the top please also checkout the original incarnation of this project:

github.com/snaptortoise/jekyll-rss-feeds