Jekyll を使用して GitHub Pages サイトを作成する

ノート: Organizationのオーナーは、Organizationが所有しているリポジトリからのGitHub Pagesサイトの公開を制限できます。詳しい情報については「GitHub Pagesサイトの公開の管理」を参照してください。

必要な環境

Jekyll を使用して GitHub Pages サイトを作成する前に、Jekyll と Git をインストールする必要があります。詳しい情報については、Jekyll ドキュメンテーションの Installation および「Git のセットアップ」を参照してください。

Jekyll をインストールし動作させるのには Bundler を使うようおすすめします。 Bundler は、Ruby gem の依存関係を管理し、Jekyll ビルドのエラーを減少させ、環境に関係するバグを防止します。以下はBundlerのインストール手順です。

Rubyをインストールしてください。詳しい情報については、Rubyのドキュメンテーションの「Rubyのインストール」を参照してください。
Bundlerをインストールしてください。詳しい情報については「Bundler」を参照してください。

参考: Bundler を使って Jekyll をインストールしようとしている時に Ruby のエラーがある場合、Ruby のインストールをマネージするために、RVM または Homebrew などのパッケージマネージャーが必要になる可能性があります。詳しい情報については、Jekyllのドキュメンテーションの「トラブルシューティング」を参照してください。

サイト用にリポジトリを作成する

サイトが独立プロジェクトなら、サイトのソースコードを保存するために新しいリポジトリを作成できます。 If your site is associated with an existing project, you can add the source code to that project's repository, in a /docs folder on the default branch or on a different branch. たとえば、すでにGitHub Enterprise Cloud上にあるプロジェクトのドキュメンテーションを公開するサイトを作成しているなら、そのサイトのソースコードはプロジェクトと同じリポジトリに保存したいでしょう。

リポジトリを所有しているアカウントがGitHub FreeもしくはOrganization用のGitHub Freeを使用しているなら、そのリポジトリはパブリックでなければなりません。

既存のリポジトリにサイトを作成したいのなら、サイトの作成セクションまでスキップしてください。

ページの右上角でドロップダウンメニューを使い、New repository（新規リポジトリ）を選択してください。
Owner（オーナー）ドロップダウンメニューを使い、リポジトリを所有したいアカウントを選択してください。

Note: If you're a managed user, you can only publish GitHub Pages sites from repositories owned by organizations. 詳しい情報については、「GitHub Pages について」を参照してください。
リポジトリの名前と、任意で説明を入力してください。ユーザもしくはOrganizationのサイトを作成しているなら、リポジトリは<user>.github.ioもしくは<organization>.github.ioという名前でなければなりません。 If your user or organization name contains uppercase letters, you must lowercase the letters. 詳しい情報については「GitHub Pagesについて」を参照してください。
リポジトリの可視性を選択してください。 For more information, see "About repositories."

サイトを作成する

サイトを作成する前には、GitHub Enterprise Cloud上にサイトのためのリポジトリを持っていなければなりません。既存のリポジトリ内にサイトを作成しようとしているのではないなら、「サイトのためのリポジトリの作成」を参照してください。

Warning: Unless your enterprise uses Enterprise Managed Users, GitHub Pages sites are publicly available on the internet by default, even if the repository for the site is private or internal. You can publish a site privately by managing access control for the site. Otherwise, if you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "About repositories" and "Changing the visibility of your GitHub Pages site."

ターミナルターミナルGit Bashを開いてください。
リポジトリのローカルコピーがまだない場合、サイトのソースファイルを保存したい場所に移動します。PARENT-FOLDER は、リポジトリを保存したいフォルダの名前に置き換えてください。
```
$ cd PARENT-FOLDER
```
ローカルの Git リポジトリをまだ初期化していない場合は、初期化します。 REPOSITORY-NAME は、リポジトリの名前に置き換えてください。
```
$ 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
```
ディレクトリをリポジトリに変更します。
```
$ cd REPOSITORY-NAME
# Changes the working directory
```
Decide which publishing source you want to use. 詳しい情報については「GitHub Pagesについて」を参照してください。
サイトの公開ソースにアクセスしてください。公開元に関する詳しい情報については、「GitHub Pages について」を参照してください。たとえば、デフォルトブランチの docs フォルダからサイトを公開することを選択した場合は、ディレクトリを作成して docs フォルダに変更します。
```
$ mkdir docs
# Creates a new folder called docs
$ cd docs
```
サイトを gh-pages ブランチから公開する場合には、gh-pages ブランチを作成してチェックアウトします。
```
$ git checkout --orphan gh-pages
# 履歴やコンテンツなしでgh-pagesという新しいブランチを作成、gh-pagesブランチに切り替え
$ git rm -rf 
# ワーキングディレクトリでデフォルトブランチからコンテンツを削除
```
新しい Jekyll サイトを作成するには、jekyll new コマンドを使用します。
```
$ jekyll new --skip-bundle .
# Creates a Jekyll site in the current directory
```
Jekyll が作成した Gemfile を開きます。
gem "jekyll" で始まる行の先頭に「#」を追加して行をコメントアウトします。
# gem "github-pages" で始まる行を編集して github-pages を追加します。行を次のように変更します。
```
gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
```
GITHUB-PAGES-VERSION をサポートされている最新バージョンの github-pages gem に置き換えます。このバージョンについては、「依存関係バージョン」を参照してください。

正しいバージョンの Jekyll は、github-pages gem の依存関係としてインストールされます。
Gemfile を保存して閉じます。
コマンドラインからbundle installを実行

あるいは、_config.ymlファイルに必要な編集を加えてください。これは、リポジトリがサブディレクトリでホストされている場合に相対パスに対して必要です。詳しい情報については「サブフォルダを分割して新しいリポジトリにする」を参照してください。

domain: my-site.github.io       # HTTPSを強制したいなら、ドメインの先頭でhttpを指定しない。例: example.com
url: https://my-site.github.io  # サイトのベースのホスト名とプロトコル。例: http://example.com
baseurl: /REPOSITORY-NAME/      # サイトがサブフォルダで提供されるならフォルダ名を置く

必要に応じて、サイトをローカルでテストします。詳しい情報については、「Jekyll を使用して GitHub Pages サイトをローカルでテストする」を参照してください。

作業内容を追加してコミットしてください。

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

GitHub.comでリモートとしてリポジトリを追加してください。USERをリポジトリを所有するアカウントで、REPOSITORYをリポジトリ名で置き換えてください。
```
$ git remote add origin https://github.com/USER/REPOSITORY.git
```
リポジトリを GitHub Enterprise Cloud にプッシュします。 BRANCH は、作業を行なっているブランチの名前に置き換えてください。
```
$ git push -u origin BRANCH
```
公開ソースを設定してください。詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。
GitHub Enterprise Cloudで、サイトのリポジトリにアクセスしてください。
リポジトリ名の下で Settings（設定）をクリックしてください。
In the "Code and automation" section of the sidebar, click Pages.
Optionally, if you're publishing a project site from a private or internal repository, choose the visibility for your site. Under "GitHub Pages", select the GitHub Pages visibility drop-down menu, then click a visibility. For more information, see "Changing the visibility of your GitHub Pages site".

ノート: GitHub Pagesサイトをプライベートで公開するには、OrganizationはGitHub Enterprise Cloudを使っていなければなりません。 For more information about how you can try GitHub Enterprise Cloud for free, see "Setting up a trial of GitHub Enterprise Cloud."
公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてください。

メモ: サイトに対する変更は、その変更をGitHub Enterprise Cloudにプッシュしてから公開されるまでに、最大10分かかることがあります。 If you don't see your GitHub Pages site changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

次のステップ

サイトに新しいページを追加したり、投稿したりするには、「Jekyll を使用して GitHub Pages サイトにコンテンツを追加する」を参照してください。

JekyllのテーマをGitHub Pagesサイトに追加して、サイトのルックアンドフィールをカスタマイズできます。詳しい情報については、「Jekyll を使用して GitHub Pages サイトにテーマを追加する」を参照してください。