Creating a GitHub Pages site with Jekyll

People with admin permissions for a repository can create a GitHub 页面 site with Jekyll.

本文内容

• 基本要求
• Creating a repository for your site
• Creating your site
• 后续步骤

基本要求

Before you can use Jekyll to create a GitHub 页面 site, you must install Jekyll and Git. For more information, see Installation in the Jekyll documentation and "Set up Git."

We recommend using Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler:

1. Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
2. Install Bundler. For more information, see "Bundler."

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 Enterprise, 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.

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 页面."

   

4. Choose to make the repository either public or private. Public repositories are visible to everyone using 您的 GitHub Enterprise Server 实例, while private repositories are only accessible to you, and people you share them with. For more information, see "Setting repository visibility."

   

Creating your site

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

1. Open TerminalTerminalGit Bashthe terminal.

2. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing PARENT-FOLDER with the folder you want to contain the folder for your repository.

   $ cd PARENT-FOLDER

3. If you haven't already, initialize a local Git repository, replacing REPOSITORY-NAME with the name of your repository.

   $ git init REPOSITORY-NAME> Initialized empty Git repository in /Users/octocat/my-site/.git/
   # Creates a new folder on your computer, initialized as a Git repository

4. Change directories to the repository.

   $ cd REPOSITORY-NAME# Changes the working directory

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

6. Navigate to the publishing source for your site. For more information about publishing sources, see "About GitHub 页面."

   For example, if you chose to publish your site from the docs folder on the master branch, create and change directories to the docs folder.

   $ mkdir docs
   # Creates a new folder called docs
   $ cd docs

   If you chose to publish your site from the gh-pages branch, create and checkout the gh-pages branch.

   $ git checkout --orphan gh-pages
   # Creates a new branch, with no history or contents, called gh-pages and switches to the gh-pages branch

7. To create a new Jekyll site, use the jekyll new command, replacing VERSION with the current dependency version for Jekyll. For more information, see "Dependency versions" on the GitHub 页面 site.

   • If you installed Bundler:

     $ bundle exec jekyll VERSION new .
     # Creates a Jekyll site in the current directory

   • If you don't have Bundler installed:

     $ jekyll VERSION new .
     # Creates a Jekyll site in the current directory

8. Open the Gemfile that was created and follow the instructions in the Gemfile's comments to use GitHub 页面.

   

9. Update the gem "github-pages" line so that the line looks like this, replacing VERSION with the current dependency version for github-pages. For more information, see "Dependency versions" on the GitHub 页面 site.

   gem "github-pages", "~> VERSION", group: :jekyll_plugins

10. Save and close the Gemfile.

11. Optionally, test your site locally. For more information, see "Testing your GitHub 页面 site locally with Jekyll."

12. Add your GitHub Enterprise repository as a remote, replacing HOSTNAME with your appliance's hostname, USER with the account that owns the repository, and REPOSITORY with the name of the repository.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git

13. Push the repository to GitHub Enterprise, replacing BRANCH with the name of the branch you're working on.

    $ git push -u origin BRANCH

14. 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."

15. On GitHub Enterprise, navigate to your site's repository.

16. 在仓库名称下，单击 Settings（设置）。

    

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

    

后续步骤

To add a new page or post to your site, see "Adding content to your GitHub 页面 site using Jekyll."

You can add a Jekyll theme to your GitHub 页面 site to customize the look and feel of your site. For more information, see "Adding a theme to your GitHub 页面 site using Jekyll."