Atom (RSS) feeds for GitHub Pages

GitHub Pages can automatically create an Atom feed for your Jekyll blog. Atom is an XML-based feed format, similar to RSS, that allows other readers to subscribe to new blog posts.

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

Note: If a feed.xml file exists in the root of your repository, GitHub Pages will not override it.

Setting up

To enable automatic feed generation, you must add the following line to your site's _config.yml file:

  - jekyll-feed

If you don't have a _config.yml file, you will need to create one in the root of your GitHub Pages repository. For more information, see Jekyll's official plugins documentation.

You may also wish to add the {% feed_meta %} tag to your layout's <head> section to allow browsers to more easily discover your site's feed.

Testing locally

To preview the output of your feed locally:

You should see a new feed.xml file generated in your Jekyll _site folder.

Further reading

Ask a human

Can't find what you're looking for?

Contact us