GitHub Metadata

GitHub Metadata, a.k.a. site.github

Actions CI Windows Build status

Jekyll plugin to propagate the site.github namespace and set default values for use with GitHub Pages.

What it does


Usage of this gem is pretty straight-forward. Add it to your Gemfile like this:

gem "jekyll-github-metadata"

Add it to your _config.yml:

  - "jekyll-github-metadata"

:warning: If you are using Jekyll < 3.5.0, use the gems key instead of plugins.

Then go ahead and run bundle install.

Now, whenever you build or serve with Jekyll, the jekyll-github-metadata plugin will run.

Further reading