Repository files navigation

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

• Propagates thesite.github namespace withrepository metadata
• Setssite.title as the repository name, if none is set
• Setssite.description as the repository tagline if none is set
• Setssite.url as the GitHub Pages domain (cname or user domain), if none is set
• Setssite.baseurl as the project name for project pages if none is set

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

gem"jekyll-github-metadata"

Add it to your_config.yml:

plugins:  -"jekyll-github-metadata"

⚠️ If you are using Jekyll < 3.5.0, use thegems key instead ofplugins.

Then go ahead and runbundle install.

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

• Authentication
• Configuration
• Usingsite.github
• Edit on GitHub link
• Development