Want to take your software engineering career to the next level? Join the mailing list for career tips & advice Click here


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

Subscribe to updates I use github-metadata

Statistics on github-metadata

Number of watchers on Github 92
Number of open issues 6
Average time to close an issue about 2 months
Main language Ruby
Average time to merge a PR 4 days
Open pull requests 13+
Closed pull requests 7+
Last commit over 2 years ago
Repo Created almost 6 years ago
Repo Last Updated over 2 years ago
Size 374 KB
Homepage https://jekyll.gi...
Organization / Authorjekyll
Latest Releasev2.9.4
Page Updated
Do you use github-metadata? Leave a review!
View open issues (6)
View github-metadata activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Software engineers: It's time to get promoted. Starting NOW! Subscribe to my mailing list and I will equip you with tools, tips and actionable advice to grow in your career.
Evaluating github-metadata for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

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

  - "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

github-metadata open issues Ask a question     (View All Issues)
  • over 3 years Add site.github.releases.latest
  • almost 4 years Add site.github.public_repositories[].wiki_url - wiki to each public repo
github-metadata open pull requests (View All Pulls)
  • Client: whitelist certain Octokit::Client methods
  • Use git remote url to determine nwo
  • Clarification on how to generate tokens, and how to configure for deployment to diff envs
  • Use localhost:4000 as the default pages host in development
  • Default to development in dev
  • remove unneeded param `type`
  • Add site.github.private_repositories field
  • Handle dots in repository names when parsing from Git remote output
  • Make the Octokit client more configurable.
  • Add commits to site.github
  • Add instructions for using DotEnv
  • Detect whether the client is connected to the internet. Only allow client calls if connected.
  • add `latest_release` and `latest_release_url`
github-metadata questions on Stackoverflow (View All Questions)
  • Combination of jekyll-redirect-from and github-metadata gems throwing errors
github-metadata list of languages used
github-metadata latest release notes

Minor Enhancements

  • Warn and do nothing when site.name is set (#113)


  • Docs: use plugins config key (#115)

Fix for site.github.* values not being propagated in some cases (#112)

  • Allow user values to override drop-determined values (#110)
Other projects in Ruby