GitHub 页面上的仓库元数据
GitHub 页面 可用于具有 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。
可用于在 GitHub 页面上托管的 Jekyll 站点的常用仓库信息,例如项目名称和说明。
用法
仓库元数据向 site.github
命名空间中 Jekyll 站点的配置公开。
简单来说,引用下面任何密钥,如同对 _config.yml 文件中存在的任何其他站点配置值一样,将该密钥加上 site.github
前缀。
例如,要列出项目的名称,您可编写类似 `The project is called
{{ site.github.project_title }}
` 的内容;或者,要列出组织的开源仓库,您可使用以下内容:
{% for repository in site.github.public_repositories %}
- [{{ repository.name }}]({{ repository.html_url }}) {% endfor %}
在本地使用仓库元数据
要在本地重新创建 site.github
命名空间,确保您已安装最新版本的 GitHub Pages Gem,并且您站点的 _config.yml
文件中含有以下行:
repository: <USERNAME>/<PROJECT>
一些元数据字段(例如您的分支名称)可能需要额外的身份验证。 按照 GitHub 元数据插件文档操作,通过创建个人访问令牌,然后在步骤 5 中选择 public_repo
范围来提供相应的凭据。
可用的仓库元数据
注:有关最新依赖项版本,请参阅“GitHub 页面 依赖项版本”。
以下示例信息向 site.github
命名空间中的 Jekyll 模板公开:
{
"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://help.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": "http://username.github.io/metadata-example", // (or the CNAME)
"baseurl": "/metadata-example",
"contributors": [ User Objects ],
"releases": [ Release Objects ],
"latest_release": [ Release Object ],
"private": false,
"license": {
"key": "mit",
"name": "MIT License",
"spdx_id": "MIT",
"url": "https://api.github.com/licenses/mit"
},
"source": {
"branch": "gh-pages",
"path": "/"
}
}
有关仓库内容和用户对象的更多信息,请参阅以下 API 端点: