8000 GitHub - inntran/github-metadata: Jekyll plugin to propagate the `site.github` namespace and set default values for use with GitHub Pages.
[go: up one dir, main page]

Skip to content

inntran/github-metadata

 
 

Repository files navigation

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

Build Status

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

What it does

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

Usage

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

gem "jekyll-github-metadata"

Now add it to your _config.yml:

plugins:
  - "jekyll-github-metadata"

⚠️ If you are using Jekyll < 3.5.0 use the gems key instead of plugins.

Then go ahead and run bundle install. Once you've done that jekyll-github-metadata will run when you run Jekyll.

Further reading

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 88.7%
  • JavaScript 9.1%
  • Shell 1.7%
  • HTML 0.5%
0