Configuring Jekyll plugins
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.
You must edit your _config.yml file to add Jekyll plugins to your GitHub Pages site.
To add Jekyll plugins to your site, you need to configure your _config.yml file by adding your plugin's Jekyll gem. This is an example of a _config.yml file that has several supported jekyll plugins enabled:
plugins:
- jekyll-mentions
- jemoji
- jekyll-redirect-from
- jekyll-sitemap
- jekyll-feedIf 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.
Tip: Make sure you're using the latest version of the GitHub Pages Gem, which contains these dependencies and plugins.
Default plugins
Default plugins are enabled by default and cannot be disabled.
- jekyll-coffeescript
- jekyll-gist
- jekyll-github-metadata
- jekyll-paginate
- jekyll-relative-links
- jekyll-optional-front-matter
- jekyll-readme-index
- jekyll-default-layout
- jekyll-titles-from-headings
Optional plugins
To enable an optional plugin, you must add it to your _config.yml file.
- jekyll-feed
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jekyll-avatar
- jemoji
- jekyll-mentions
- jekyll-include-cache