ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
記事のバージョン: Enterprise Server 2.15

このバージョンの GitHub Enterprise はこの日付をもって終了となります: このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2019-10-16. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの改善、新機能のためには、最新バージョンのGitHub Enterpriseにアップグレードしてください。 アップグレードに関する支援については、GitHub Enterprise supportに連絡してください。

Jekyll を使用して GitHub Pages サイトをローカルでセットアップする

ローカルでサイトへの変更をテストするために、Jekyll GitHub Pages サイトのローカルバージョンをセットアップできます。 サイトをプレビューし失敗した Jekyll のビルドの問題解決をサポートするために、Jekyll のインストールを強く推奨します。

GitHub Pages は、GitHub Free のパブリックリポジトリ、GitHub Pro のパブリックおよびプライベートリポジトリ、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server で利用いただけます。

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

Windows は、Jekyll を公式にはサポートしていません。 詳しい情報については、Jekyll の公式資料「Windows 上の Jekyll」を参照してください。

要件

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

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

  2. Ruby 2.1.0 またはこれ以降のバージョンが入っているかどうか確認します:

    $ ruby --version
    > ruby 2.X.X
  3. Ruby をインストールしていない場合、Ruby 2.1.0 またはこれ以降のバージョンをインストールします。

  4. Bundlerのインストールをします。

    $ gem install bundler
    # Installs the Bundler gem
  5. Jekyll サイトのためのローカルリポジトリを持っている場合、ステップ 2 に進んでください。

ステップ 1: Jekyll サイトのためのローカルリポジトリの作成

  1. まだ Git をダウンロードしていない場合、インストールします。 詳細は「Git のセットアップ」を参照してください。 1. ターミナルターミナルGit Bashターミナル を開いてください。 を参照してください。

  2. ローカルのコンピュータに、Jekyllサイトのための新しいGitリポジトリをイニシャライズします。

    $ git init JEKYLL-SITE-REPOSITORY-NAME
    > Initialized empty Git repository in /Users/octocat/my-site/.git/
    # Creates a new file directory on your local computer, initialized as a Git repository
  3. 作成した新しいリポジトリにディレクトリを変更します:

    $ cd JEKYLL-SITE-REPOSITORY-NAME
    # Changes the working directory
  4. 新しいローカルリポジトリがプロジェクト pages サイトのためである場合、新しい gh-pages ブランチを作成します。

    メモ: プロジェクトページに master ブランチを使う場合、このステップをスキップできます。 ブランチをチェックアウトしていない場合、ローカルリポジトリでコミットした後、変更がデフォルトで master ブランチに表示されます。

    $ git checkout -b gh-pages
    > Switched to a new branch 'gh-pages'
    # Creates a new branch called 'gh-pages', and checks it out

    参考: ユーザ、Organization またはプロジェクトページおよびどのブランチを使うのかをさらに学ぶには、「ユーザ、Organization およびプロジェクトページ」を参照してください。 master ブランチの /docs フォルダからサイトのソースファイルを作成する方法をさらに学ぶには、「GitHub Pages のパブリッシングソースを設定する」を参照してください。

ステップ 2: Bundler を使った Jekyll のインストール

サイトの依存関係を記録するために、ruby は、Jekyll サイトをビルドする Gemfile のコンテンツを使います。

  1. ローカルの Jekyll サイトのリポジトリに Gemfile があるかどうかを確認します。

    $ ls
    > Gemfile

Gemfile がある場合、ステップ 4 に進みます。 Gemfile がない場合、ステップ 2 に進みます。

  1. Gemfile がない場合、Atom などのあなたの好みのテキストエディタを開いて、以下の行を新しいファイルに追加します:

    source 'https://rubygems.org'
    gem 'github-pages', group: :jekyll_plugins
  2. ファイルに Gemfile という名前を付けて、ローカルの Jekyll サイトのリポジトリのルートディレクトリに保存します。 Jekyll をインストールするために、ステップ 5 に進みます。

  3. すでに Gemfile がある場合、Atom など、お好みのテキストエディタを開いて、以下の行を Gemfile に追加します:

    source 'https://rubygems.org'
    gem 'github-pages', group: :jekyll_plugins
  4. GitHub Enterprise Pages gem から、Jekyll および他の依存関係をインストールします。

    $ bundle install
    > Fetching gem metadata from https://rubygems.org/............
    > Fetching version metadata from https://rubygems.org/...
    > Fetching dependency metadata from https://rubygems.org/..
    > Resolving dependencies...

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

ステップ 3 (オプション): Jekyll サイトのファイルの作成

Jekyll サイトをローカルで構築し、サイトの変更をプレビューし、ビルドエラーを解決するには、ローカルのコンピュータに Jekyll サイトのファイルがある必要があります。 Jekyll サイトのリポジトリをクローンした場合、Jekyll サイトのファイルがローカルコンピュータにあるかもしれません。 Jekyll サイトをダウンロードしていない場合、ローカルリポジトリの基本的な Jekyll テンプレートサイトの Jekyll サイトファイルを作成できます。

Jekyll サイトのテンプレートとして GitHub 上の既存の Jekyll サイトリポジトリを使いたい場合、ローカルのコンピュータで Github 上の Jekyll サイトリポジトリをフォークしてクローンします。 詳細は「リポジトリをフォークする」を参照してください。

メモ: Jekyll 3.2 から、デフォルトの Jekyll サイトには、あなたがビルドした gem のバージョンに Gemfile をロックする Gemfile が含まれています。 そうせずに、GitHub Pages が使用したバージョンにロックするには、下記の手順で gem "github-pages", group: :jekyll_plugins 行をコメント解除します。

  1. ローカルコンピュータに Jekyll サイトがまだない場合、新しいディレクトリで Jekyll テンプレートサイトを作成します。

    $ bundle exec jekyll _3.3.0_ new NEW-JEKYLL-SITE-REPOSITORY-NAME
    > New jekyll site installed in /Users/octocat/NEW-JEKYLL-SITE-REPOSITORY-NAME.
  2. 新しいサイトディレクトリに移動します。

    $ cd NEW-JEKYLL-SITE-REPOSITORY-NAME
  3. Gemfile を編集して、次の行を削除します:

    $ "jekyll", "3.3.0"
  4. Gemfile で、この行の冒頭にある # を削除します:

    $ gem "github-pages", group: :jekyll_plugins
  5. サイトディレクトリを Git リポジトリとして初期化します。

    $ git init
    > Initialized empty Git repository in /Users/octocat/name-of-your-directory
  6. GitHub PagesサイトのためのローカルリポジトリへGitHub Enterprise上のリモートリポジトリを接続します。

    $ git remote add origin https://github.com/username-or-organization-name/your-remote-repository-name
  7. Jekyll テンプレートサイトを編集するには、テキストエディタで新しい Jekyll サイトファイルを開きます。 テキストエディタで変更して保存します。 Git を使ってこれらの変更をコミットしなくても、サイトを構築するための Jekyll コマンドを実行すると、ローカルのコンピュータでこれらの変更をプレビューできます。

  8. 変更を追加またはステージングします。

    $ git add .
  9. 変更をコメントを付けてコミットします。

    $ git commit -m "updated site"
  10. GitHub Pages サイトで変更を公開するためには、GitHub Enterprise 上のリモートリポジトリに変更をプッシュします。

    $ git push -u origin master

この Git ワークフローの使用の詳しい情報については、「Git および GitHub Enterprise を学習するための良いリソース」、または、こちらの Git チートシートを参照してください。

ステップ 4: ローカルの Jekyll サイトの構築

  1. ローカル Jekyll サイトリポジトリのルートディレクトリに移動します。

  2. ローカルで Jekyll サイトを実行します:

    $ bundle exec jekyll serve
    > Configuration file: /Users/octocat/my-site/_config.yml
    >            Source: /Users/octocat/my-site
    >       Destination: /Users/octocat/my-site/_site
    > Incremental build: disabled. Enable with --incremental
    >      Generating...
    >                    done in 0.309 seconds.
    > Auto-regeneration: enabled for '/Users/octocat/my-site'
    > Configuration file: /Users/octocat/my-site/_config.yml
    >    Server address: http://127.0.0.1:4000/
    >  Server running... press ctrl-c to stop.
  3. http://localhost:4000 のウェブブラウザでローカル Jekyll サイトをプレビューします。

GitHub Pages gemでサイトを最新に保つ

Jekyll はアクティブなオープンソースプロジェクトで、頻繁に更新されます。 GitHub Enterprise Pages サーバーが更新されると、あなたのコンピュータのソフトウェアは古いものとなり、ローカルでのサイトの見え方が、使用している GitHub Enterprise Serverインスタンス 上で公開した時の見え方とは異なる可能性があります。 1. ターミナルターミナルGit Bashターミナル を開いてください。

  1. この更新コマンドを実行してください:

    • 私たちの推奨セットアップに従い Bundler をインストールした場合、bundle update github-pages を実行するか、単に bundle update を実行すれば、すべての gem が最新バージョンに更新されます。
    • Bundler をインストールしていない場合、gem update github-pages を実行します。

次のステップ: Jekyll を設定する

あなたのページサイトをさらに設定するには、「Jekyll を設定する」を参照してください。プロジェクトページサイトをセットアップするには、プロジェクトページ URL 上の Jekyll 公式ドキュメンテーションを参照してください。

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください