我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们
文章版本: GitHub.com

Creating a GitHub Pages site

You can create a GitHub 页面 site in a new or existing repository.

GitHub 页面 可用于具有 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。更多信息请参阅“GitHub 的产品。”

本文内容

Creating a repository for your site

If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code for your site to a gh-pages branch or a docs folder on the master branch in that project's repository. For example, if you're creating a site to publish documentation for a project that's already on GitHub, you may want to store the source code for the site in the same repository as the project.

If you want to create a site in an existing repository, skip to the "Creating your site" section.

警告:GitHub 页面 站点在互联网上向公众开放,即使其仓库是私有的。如果您的页面仓库中有敏感数据,可能需要在发布之前将其删除。

  1. 在任意页面的右上角,单击 ,然后单击 New repository(新建仓库)

    含有创建新仓库选项的下拉菜单

  2. 使用 Owner(所有者)下拉菜单,选择要拥有仓库的帐户。

    所有者下拉菜单

  3. Type a name for your repository and an optional description. If you're creating a user or organization site, your repository must be named <user>.github.io or <organization>.github.io. For more information, see "About GitHub 页面."

    Create repository field

  4. Choose to make the repository either public or private. Public repositories are visible to the public, while private repositories are only accessible to you, and people you share them with. For more information, see "Setting repository visibility."

    Radio buttons to select private or public status

  5. 选择 Initialize this repository with a README(使用自述文件初始化此仓库)

    Initialize this repository with a README checkbox

  6. 单击 Create repository(创建仓库)

Creating your site

Before you can create your site, you must have a repository for your site on GitHub. If you're not creating your site in an existing repository, see "Creating a repository for your site."

  1. On GitHub, navigate to your site's repository.

  2. 如果是创建项目站点,请确定您要使用哪一个发布来源。如果是创建用户或组织站点,您必须将站点的源代码存储在 master 分支上。更多信息请参阅“关于 GitHub 页面”。

  3. If your chosen publishing source already exists, navigate to the publishing source. If your chosen publishing source doesn't exist, create the publishing source.

  4. In the root of the publishing source, create a new file called index.md that contains the content you want to display on the main page of your site.

  5. If you're using a non-default publishing source for a project site, configure your publishing source. For more information, see "Configuring a publishing source for your GitHub 页面 site."

  6. 在仓库名称下,单击 Settings(设置)

    仓库设置按钮

  7. To see your published site, under "GitHub 页面", click your site's URL.

    URL of your published site

Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to GitHub. If your don't see your changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub 页面 sites."

Note: If your site's source files are located in the default publishing source—master for user and organization sites or gh-pages for project sites—but your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the default publishing source.

后续步骤

You can add more pages to your site by creating more new files. Each file will be available on your site in the same directory structure as your publishing source. For example, if the publishing source for your project site is the gh-pages branch, and you create a new file called /about/contact-us.md on the gh-pages branch, the file will be available at https://<user>.github.io/<repository>/about/contact-us.md.

You can also add a theme to customize your site’s look and feel. For more information, see "Adding a theme to your GitHub 页面 site with the theme chooser."

To customize your site even more, you can use Jekyll, a static site generator with built-in support for GitHub 页面. For more information, see "About GitHub 页面 and Jekyll."

延伸阅读

问问别人

找不到要找的内容?

联系我们