Need help with github-metadata?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jekyll
202 Stars 103 Forks MIT License 477 Commits 13 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

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

Linux Build Status Windows 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"

:warning: 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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.