Access site.github metadata anywhere (...you have an internet connection).

First, a very special thanks to GitHub (especially Ben Balter and their legal team) for allowing me to open-source this code. ❤️

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

gem 'jekyll-github-metadata'

Then go ahead and run bundle install. Once you've done that, add your repo & the gem to your _config.yml:

repository: me/super-cool-project
gems: ['jekyll-github-metadata']

Then run jekyll like you normally would and your site.github.* fields should fill in like normal.

For some fields, like cname, you need to authenticate yourself. Luckily it's pretty easy. You have 2 options:

These tokens are easy to use and delete so if you move around from machine-to-machine, we'd recommend this route. Set JEKYLL_GITHUB_TOKEN to your access token (with public_repo scope) when you run jekyll, like this:

$ JEKYLL_GITHUB_TOKEN=123abc [bundle exec] jekyll serve

If you prefer to use the good ol' ~/.netrc file, just make sure the netrc gem is bundled and run jekyll like normal. So if I were to add it, I'd add gem 'netrc' to my Gemfile, run bundle install, then run bundle exec jekyll build. The machine directive should be api.github.com.

We use Octokit to make the appropriate API responses to fetch the metadata. You may set OCTOKIT_ACCESS_TOKEN and it will be used to access GitHub's API.

$ OCTOKIT_ACCESS_TOKEN=123abc [bundle exec] jekyll serve

Working with jekyll-github-metadata and GitHub Enterprise? No sweat. You can configure which API endpoints this plugin will hit to fetch data.

• OCTOKIT_API_ENDPOINT – the full hostname and protocol for the api, default: https://api.github.com
• OCTOKIT_WEB_ENDPOINT – the full hostname and protocol for the website, default: https://github.com
• PAGES_PAGES_HOSTNAME – the full hostname from where GitHub Pages sites are served, default: github.io.

MIT License, credit to GitHub, Inc. See LICENSE for more details.