https://github.com/jekyll/github-metadata

Jekyll plugin to propagate the `site.github` namespace and set default values for use with GitHub Pages.
https://github.com/jekyll/github-metadata

github jekyll jekyll-plugin octokit ruby

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jekyll/github-metadata
• Owner: jekyll
• License: mit
• Created: 2014-09-16T06:32:03.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2025-03-24T14:25:07.000Z (23 days ago)
• Last Synced: 2025-04-13T22:18:09.852Z (3 days ago)
• Topics: github, jekyll, jekyll-plugin, octokit, ruby
• Language: Ruby
• Homepage: https://jekyll.github.io/github-metadata/
• Size: 515 KB
• Stars: 292
• Watchers: 13
• Forks: 138
• Open Issues: 12
• Metadata Files:
  • Readme: docs/README.md
  • Changelog: History.markdown
  • License: LICENSE

Awesome Lists containing this project

• awesome-jekyll-plugins - **GitHub Metadata** - github-metadata](https://rubygems.org/gems/jekyll-github-metadata)) -- `site.github` **#Official** **#GitHub Pages** (Other)

README

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

[![Actions CI](https://github.com/jekyll/github-metadata/actions/workflows/ci.yaml/badge.svg)](https://github.com/jekyll/github-metadata/actions/workflows/ci.yaml)

[![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/github-metadata/master.svg?label=Windows%20build)][appveyor]

[travis]: https://travis-ci.org/jekyll/github-metadata

[appveyor]: https://ci.appveyor.com/project/jekyll/github-metadata

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](site.github.md)

* 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 `Gemfile` like this:

```ruby

gem "jekyll-github-metadata"

```

Add it to your `_config.yml`:

```yaml

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`.

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

## Further reading

* [Authentication](authentication.md)

* [Configuration](configuration.md)

* [Using `site.github`](site.github.md)

* [Edit on GitHub link](edit-on-github-link.md)

* [Development](development.md)