Giter VIP home page Giter VIP logo

jekyll-rss's Introduction

Jekyll::RSS

Generate some RSS/Atom feeds for your Jekyll blog.

Installation

Add the following to your Gemfile:

group :jekyll_plugins do
  gem 'jekyll-rss'
end

Usage

Execute the rss_templates Jekyll subcommand to generate the necessary templates onto your source directory:

jekyll rss_templates --blog --category

This will create an _rss directory on your source directory with two files -- blog.xml and category.xml, which is read by the generator to generate the all-encompassing feed and the categorized feeds respectively.

You can omit either --blog or --category depending on your needs.

Next step is to enable the plugin by adding this to your _config.yml:

rss: true

or

rss:
   paginate: 5 #Number of posts per page.

Permalinks

The permalink for the feeds can be configured from within the front-matter of the template files.

Default config

_rss/blog.xml:

permalink: /rss/feed.xml
paginated_permalink: /rss/:num/feed.xml

Result:

/rss/feed.xml, /rss/1/feed.xml, /rss/2/feed.xml, etc.

Default config

rss/category.xml

permalink: /rss/:category.xml
paginated_permalink: /rss/:num/:category.xml

Result:

/rss/foobar.xml, /rss/1/foobar.xml, /rss/2/foobar.xml, etc.

Note that the permalink must end with .xml, so that the proper content type is detected even when using the least capable of web-servers i.e. a public hosted directory like an Amazon S3 bucket.

jekyll-rss's People

Contributors

bezhermoso avatar tomfriedhof avatar

Stargazers

ProbablePrime avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.