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

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

記事のバージョン: Enterprise Server 2.17

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

新規または既存のリポジトリ内に、GitHub Pages Jekyll を使用してサイトを作成できます。

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

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

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

必要な環境

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

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

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

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

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

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

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

Warning: If your site administrator has enabled Public Pages, GitHub Pages sites are publicly available on the internet, even if their repositories are private. サイトのリポジトリにセンシティブなデータがあるなら、公開前にそれを取り除くのが良いでしょう。 For more information, see "Configuring GitHub Pages on your appliance" and "About repository visibility."

  1. ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。
    新しいリポジトリを作成する選択肢を持つドロップダウン
  2. Owner(オーナー)ドロップダウンメニューを使い、リポジトリを所有したいアカウントを選択してください。
    [Owner] ドロップダウンメニュー
  3. リポジトリの名前と、任意で説明を入力してください。 ユーザもしくはOrganizationのサイトを作成しているなら、リポジトリは<user>.github.ioもしくは<organization>.github.ioという名前でなければなりません。 詳細については、「GitHub Pagesについて」を参照してください。
    リポジトリ作成フィールド
  4. Choose a repository visbility. For more information, see "About repository visibility."
    Radio buttons to select repository visibility

サイトを作成する

サイトを作成する前には、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 を使用します。

    Gemfile の更新についての説明

  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をクリックしてください。

    公開されたサイトのURL

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

ノート: サイトのソースファイルがデフォルトの公開ソース、すなわちユーザ及びOrganizationのサイトであればmaster、プロジェクトのサイトであればgh-pagesにありながら、サイトが自動的に公開されない場合は、管理権限と認証済みメールアドレスを持つ人がデフォルトの公開ソースにプッシュしていることを確認してください。

次のステップ

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

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

担当者にお尋ねください

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

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