📝 Edit on GitHub
Standard plugins
How to add common plugins to your site
These are useful to add for most sites and work on GH Pages.
Setup
How to setup a plugin
- Add to your
Gemfile
- Run
bundle install
locally. - Add the plugin to the config’s
plugins
section. - Follow any plugin-specific setup like configuring and adding your layouts.
Plugins
RSS feed
- Repo: jekyll-feed
-
“A Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts.”_
-
The plugin will automatically generate an Atom feed at /feed.xml.
-
- Produce an feed of posts.
- If you don’t have a
_posts
directory, this won’t be useful for you. - But useful for consumers of your blog add to their reader tools.
- This uses Atom and not RSS, which is explained why in the docs.
- If you don’t have a
- Follow the docs to configure.
- After installing, add to your
head
HTML tag such as in_layouts/default.html
.{% feed_meta %}
Sample:
index.html
- The reason for the metadata is to generate a tag like this from /michaelcurrin.github.io/jekyll-blog-demo. ```html
```
feed.xml
- See file at michaelcurrin.github.io/jekyll-blog-demo/feed.xml. A piece is shown below. ```xml
First post! 2018-12-22T00:00:00+00:00 2018-12-22T00:00:00+00:00 https://michaelcurrin.github.io/jekyll-blog-demo/2018/12/22/first-post This is my first post after the one created as part of the blog template.
This is my first post after the one created as part of the blog template. ```
SEO tag
- Repo: jekyll-seo-tag
- This adds metadata for search engines to use, including
title
,meta
and a canonical tag. If you use this plugin, you don’t need to settitle
yourself or in a theme layout (as you’d duplicate the tag). - After installing, add to your
head
HTML tag such as in_layouts/default.html
.{% seo %}
- See the advanced usage in the docs for setting authors and image OG data.
Sample:
index.html
- From michaelcurrin.github.io/dev-cheatsheets: ```html
Home | Dev Cheatsheets ```
Sitemap and robots
- Repo: jekyll-sitemap
- Adds a
sitemap.xml
androbots.txt
file to the site. - Sample: michaelcurrin.github.io/dev-cheatsheets/sitemap.xml
- Sample: michaelcurrin.github.io/dev-cheatsheets/robots.txt