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-1c9a"
expires: Wed, 16 Jul 2025 18:28:05 GMT
cache-control: max-age=600
content-encoding: gzip
x-proxy-cache: MISS
x-github-request-id: 8608:6256:1FDC89:20159E:6877ECD2
accept-ranges: bytes
age: 0
date: Wed, 16 Jul 2025 18:18:05 GMT
via: 1.1 varnish
x-served-by: cache-bom4737-BOM
x-cache: MISS
x-cache-hits: 0
x-timer: S1752689885.970549,VS0,VE406
vary: Accept-Encoding
x-fastly-request-id: c7433aa247998f93c40daea7785be83005a28bc9
content-length: 2305
Using site.github | GitHub Metadata
Using
GitHub Metadata
Using site.github
Common repository information, such as the project name and description, is available to Jekyll sites using jekyll-github-metadata
including GitHub Pages sites.
Usage
Repository metadata is exposed to your Jekyll site’s configuration in the site.github
namespace.
Simply, reference any of the below keys as you would any other site configuration value present in your _config.yml
file, prefacing the key with site.github
.
For example, to list a project’s name, you might write something like The project is called github-metadata
or to list an organization’s open source repositories, you might use the following:
{% for repository in site.github.public_repositories %}
* [{{ repository.name }}]({{ repository.html_url }})
{% endfor %}
Available repository metadata
The following sample information is exposed to Jekyll templates in the site.github
namespace:
{
"versions": {
"jekyll": <version>,
"kramdown": <version>,
"liquid": <version>,
"maruku": <version>,
"rdiscount": <version>,
"redcarpet": <version>,
"RedCloth": <version>,
"jemoji": <version>,
"jekyll-mentions": <version>,
"jekyll-redirect-from": <version>,
"jekyll-sitemap": <version>,
"github-pages": <version>,
"ruby": <version>"
},
"hostname": "github.com",
"pages_hostname": "github.io",
"api_url": "https://api.github.com",
"help_url": "https://docs.github.com",
"environment": "dotcom",
"pages_env": "dotcom",
"public_repositories": [ Repository Objects ],
"organization_members": [ User Objects ],
"build_revision": "cbd866ebf142088896cbe71422b949de7f864bce",
"project_title": "metadata-example",
"project_tagline": "A GitHub Pages site to showcase repository metadata",
"owner_name": "github",
"owner_url": "https://github.com/github",
"owner_gravatar_url": "https://github.com/github.png",
"repository_url": "https://github.com/github/metadata-example",
"repository_nwo": "github/metadata-example",
"repository_name": "metadata-example",
"zip_url": "https://github.com/github/metadata-example/zipball/gh-pages",
"tar_url": "https://github.com/github/metadata-example/tarball/gh-pages",
"clone_url": "https://github.com/github/metadata-example.git",
"releases_url": "https://github.com/github/metadata-example/releases",
"issues_url": "https://github.com/github/metadata-example/issues",
"wiki_url": "https://github.com/github/metadata-example/wiki",
"language": null,
"is_user_page": false,
"is_project_page": true,
"show_downloads": true,
"url": "https://username.github.io/metadata-example", // (or the CNAME)
"baseurl": "/metadata-example",
"contributors": [ User Objects ],
"releases": [ Release Objects ],
"latest_release": [ Release Object ],
"private": false,
"archived": false,
"disabled": false,
"license": {
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"source": {
"branch": "gh-pages",
"path": "/"
}
}
This site is open source. Improve this page.