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

ここには以下の内容があります:

• 必要な環境
• サイト用にリポジトリを作成する
• サイトを作成する
• 次のステップ

リポジトリの管理者権限があるユーザは、Jekyll を使用して GitHub Pages サイトにコンテンツを作成できます。

必要な環境

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

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

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

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

サイトが独立プロジェクトなら、サイトのソースコードを保存するために新しいリポジトリを作成できます。 サイトが既存のプロジェクトと関連しているなら、サイトのソースコードをそのプロジェクトのリポジトリのgh-pagesブランチもしくはmasterブランチのdocsフォルダに追加できます。 たとえば、すでにGitHub Enterprise上にあるプロジェクトのドキュメンテーションを公開するサイトを作成しているなら、そのサイトのソースコードはプロジェクトと同じリポジトリに保存したいでしょう。

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

1. ページの右上角で ドロップダウンメニューを使い、New repository（新規リポジトリ）を選択してください。

   

2. Owner（オーナー）ドロップダウンメニューを使い、リポジトリを所有したいアカウントを選択してください。

   

3. リポジトリの名前と、任意で説明を入力してください。 ユーザもしくはOrganizationのサイトを作成しているなら、リポジトリは<user>.github.ioもしくは<organization>.github.ioという名前でなければなりません。 詳細については、「GitHub Pagesについて」を参照してください。

   

4. リポジトリをパブリックにするかプライベートにするかを選択してください。 パブリックなリポジトリは、使用している GitHub Enterprise Serverインスタンスを使う全員から見ることができますが、プライベートリポジトリはあなたと、あなたが共有した人々からだけ見ることができます。 詳細は「リポジトリの可視性を設定する」を参照してください。

   

サイトを作成する

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

1. ターミナルターミナルGit Bashを開いてください。

2. リポジトリのローカルコピーがまだない場合、サイトのソースファイルを保存したい場所に移動します。PARENT-FOLDER は、リポジトリを保存したいフォルダの名前に置き換えてください。

   $ cd PARENT-FOLDER

3. ローカルの 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

4. ディレクトリをリポジトリに変更します。

   $ cd REPOSITORY-NAME
   # Changes the working directory

5. プロジェクトサイトを作成しているなら、使いたい公開ソースを決めてください。 ユーザもしくはOrganizationのサイトを作成しているなら、サイトのソースコードはmasterブランチに保存しなければなりません。 詳しい情報については「GitHub Pagesについて」を参照してください。

6. サイトの公開ソースにアクセスしてください。 公開元に関する詳しい情報については、「GitHub Pages について」を参照してください。

   たとえは、サイトを master ブランチの docs フォルダから公開する場合には、docs フォルダを作成して、ディレクトリを docs フォルダに変更します。

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

   サイトを gh-pages ブランチから公開する場合には、gh-pages ブランチを作成してチェックアウトします。

   $ 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. 新しい Jekyll サイトを作成するには、jekyll new コマンドを使用します。VERSION は、Jekyll の現在の依存関係バージョンに置き換えてください。 詳しい情報については、GitHub Pages サイトで「依存関係のバージョン」を参照してください。

   • Bundler をインストールしている場合、以下のコマンドを入力します。

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

   • Bundler をインストールしていない場合、以下のコマンドを入力します。

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

8. 作成された Gemfile を開き、Gemfile のコメントに従って GitHub Pages を使用します。

   

9. gem "github-pages" の行を以下のように更新します。VERSION は、github-pages の現在の依存関係バージョンに置き換えてください。 詳しい情報については、GitHub Pages サイトで「依存関係のバージョン」を参照してください。

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

10. Gemfile を保存して閉じます。

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

12. GitHub Enterprise リポジトリをリモートとして追加します。HOSTNAME はアプライアンスのホスト名に、USER はリポジトリ所有者のアカウントに、そして REPOSITORY はリポジトリの名前に置き換えてください。

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

13. リポジトリを GitHub Enterprise にプッシュします。 BRANCH は、作業を行なっているブランチの名前に置き換えてください。

    $ git push -u origin BRANCH

14. プロジェクトサイトにデフォルトではない公開ソースを使っているなら、公開ソースを設定してください。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

15. GitHub Enterpriseで、サイトのリポジトリにアクセスしてください。

16. リポジトリ名の下で Settings（設定）をクリックしてください。

    

17. 公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてください。

    

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

次のステップ

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

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