CARVIEW |
Select Language
HTTP/2 200
server: GitHub.com
content-type: text/html; charset=utf-8
last-modified: Mon, 24 Mar 2025 14:25:48 GMT
access-control-allow-origin: *
etag: W/"67e16b6c-16a5"
expires: Fri, 18 Jul 2025 20:04:07 GMT
cache-control: max-age=600
content-encoding: gzip
x-proxy-cache: MISS
x-github-request-id: 6AF0:2C671C:CDF2F:D2348:687AA65E
accept-ranges: bytes
age: 0
date: Fri, 18 Jul 2025 19:54:07 GMT
via: 1.1 varnish
x-served-by: cache-bom4736-BOM
x-cache: MISS
x-cache-hits: 0
x-timer: S1752868448.621335,VS0,VE315
vary: Accept-Encoding
x-fastly-request-id: 85bf97f0c647f69d3983e4a5ddd4cb3a8a6dd2b8
content-length: 1844
GitHub Metadata, a.k.a. site.github | GitHub Metadata
GitHub Metadata, a.k.a.
GitHub Metadata
GitHub Metadata, a.k.a. site.github
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 Gemfile
like this:
gem "jekyll-github-metadata"
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
.
Now, whenever you build or serve with Jekyll, the jekyll-github-metadata
plugin will run.
Further reading
This site is open source. Improve this page.