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

Creating a GitHub Pages site

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

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."

本文内容

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.

Warning: GitHub Pages sites are publicly available on the internet, even if their repositories are private. If you have sensitive data in your site's repository, you may want to remove it before publishing.

  1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

    Drop-down with option to create a new repository

  2. Use the Owner drop-down menu, and select the account you want to own the repository.

    所有者下拉菜单

  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. 更多信息请参阅“关于 GitHub Pages”。

    创建仓库字段

  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. 更多信息请参阅“设置仓库可见性”。

    用于选择机密或公开状态的单选按钮

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

    使用自述文件初始化此仓库复选框

  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. If you're creating a project site, decide which publishing source you want to use. If you're creating a user or organization site, you must store your site's source code on the master branch. For more information, see "About GitHub Pages."

  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. 更多信息请参阅“配置 GitHub Pages 站点的发布来源”。

  6. Under your repository name, click Settings.

    Repository settings button

  7. To see your published site, under "GitHub Pages", 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 Pages 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 Pages 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 Pages. 更多信息请参阅“关于 GitHub Pages 和 Jekyll”。

延伸阅读

问问别人

找不到要找的内容?

联系我们