Creating a GitHub Pages site with Jekyll

注: Organization の所有者は、Organization が所有しているリポジトリからの GitHub Pages サイトの公開を制限できます。詳細については、GitHub Pages サイトの公開の管理に関するページを参照してく� さい。

Prerequisites

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

Bundler を使用して Jekyll をインストールして実行することをお勧めします。 Bundler は、Ruby gem の依存関係を管理し、Jekyll ビルドのエラーを減少させ、環境に関係するバグを防止します。以下はBundlerのインストール手� �です。

Ruby をインストールします。詳細については、Ruby ドキュメントの「Installing Ruby」 (Ruby のインストール) を参照してく� さい。
Bundlerをインストールしてく� さい。詳細については、「Bundler」を参照してく� さい。

ヒント: Bundler を使用して Jekyll をインストールしようとしたときに Ruby エラーが表示された� �合は、RVM や Homebrew などのパッケージマネージャーを使用して Ruby のインストールを管理することが必要になる� �合があります。詳細については、Jekyll ドキュメントのトラブルシューティングを参照してく� さい。

Creating a repository for your site

リポジトリを作成することも、自分のサイト用の既存のリポジトリを選ぶこともできます。

リポジトリに対して GitHub Pages サイトを作成したい� �合、そのリポジトリ内のすべてのファイルがサイトに関連付けられるわけではないのなら、そのサイトに対して公開元を構成することができます。たとえば、自分のサイトソースファイル。

既存のリポジトリにサイトを作成する� �合は、「サイトを作成する」セクションに進んでく� さい。

ページの右上隅で、[] ドロップダウンメニューを使用して、 [新しいリポジトリ] を選択します。
[所有者] ドロップダウンメニューを使い、リポジトリを所有させたいアカウントを選択します。
リポジトリの名前と、任意で説明を入力してく� さい。ユーザーまたは Organization サイトを作成する� �合は、リポジトリに <user>.github.io または <organization>.github.io という名前を付ける必要があります。ユーザーまたは Organization の名前に大文字が含まれている� �合は、小文字にする必要があります。詳細については、「GitHub Pages について」を参照してく� さい。
リポジトリの可視性を選択してく� さい。詳細については、リポジトリに関する説明を参照してく� さい。

Creating your site

サイトを作成する前には、GitHub Enterprise Server上にサイトのためのリポジトリを持っていなければなりません。既存のリポジトリにサイトを作成していない� �合は、「サイト用にリポジトリを作成する」を参照してく� さい。

警告: サイト管理者がパブリックページを有効にしている� �合、サイトのリポジトリがプライベートまたは内部であっても、GitHub Pages サイトはインターネット上で一般公開されます。サイトのリポジトリにセンシティブなデータがあるなら、公開前にそのデータを取り除くのが良いでしょう。詳細については、「エンタープライズで GitHub Pages を構成する」および「リポジトリについて」を参照してく� さい。

[ターミナル][ターミナル][Git Bash] を開きます。
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
```

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

Change directories to the repository.

$ cd REPOSITORY-NAME
# Changes the working directory

使用する公開ソースを決定します。詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してく� さい。
サイトの公開ソースにアクセスしてく� さい。詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してく� さい。 For example, if you chose to publish your site from the docs folder on the default 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
$ git rm -rf .
# Removes the contents from your default branch from the working directory
```

To create a new Jekyll site, use the jekyll new command:

$ jekyll new --skip-bundle .
# Creates a Jekyll site in the current directory

Open the Gemfile that Jekyll created.
Add "#" to the beginning of the line that starts with gem "jekyll" to comment out this line.
Add the github-pages gem by editing the line starting with # gem "github-pages". Change this line to:
```
gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
```
Replace GITHUB-PAGES-VERSION with the latest supported version of the github-pages gem. You can find this version here: "Dependency versions."

The correct version Jekyll will be installed as a dependency of the github-pages gem.
Save and close the Gemfile.
From the command line, run bundle install.

Optionally, make any necessary edits to the _config.yml file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "Splitting a subfolder out into a new repository."

domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder

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

Add and commit your work.

git add .
git commit -m 'Initial GitHub pages site with Jekyll'

Add your repository on your GitHub Enterprise Server instance as a remote, replacing HOSTNAME with your enterprise'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
```
Push the repository to GitHub Enterprise Server, replacing BRANCH with the name of the branch you're working on.
```
$ git push -u origin BRANCH
```
公開ソースを設定してく� さい。詳細については、「GitHub Pages サイトの公開元を設定する」を参照してく� さい。
GitHub Enterprise Serverで、サイトのリポジトリにアクセスしてく� さい。
リポジトリ名の下の [ 設定] をクリックします。
In the left sidebar, click Pages.
公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてく� さい。

注: サイトに対する変更は、その変更を GitHub Enterprise Server にプッシュしてから公開されるまでに、最大 10 分かかることがあります。 GitHub Pages サイトの変更が 1 時間経ってもブラウザーに反� されない� �合は、「GitHub Pages サイトの Jekyll ビルドエラーについて」を参照してく� さい。

注: サイトが自動的に公開されていない� �合は、管理者アクセス許可と検証済みの電子メールアドレスを持つユーザーが公開ソースにプッシュしていることを確認してく� さい。

Next steps

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

JekyllのテーマをGitHub Pagesサイトに追� して、サイトのルックアンドフィールをカスタマイズできます。 For more information, see "Adding a theme to your GitHub Pages site using Jekyll."