Skip to main content

このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-01-18. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせく� さい

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

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

Who can use this feature

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

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

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

前提条件

Jekyll を使用して GitHub Pages サイトを作成する前に、Jekyll と Git をインストールする必要があります。 詳細については、Jekyll ドキュメントの「インストール」と「Git の設定」を参照してく� さい。

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

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

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

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

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

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

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

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

サイトを作成する

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

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

  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. 使用する公開ソースを決定します。 詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してく� さい。 1. サイトの公開ソースにアクセスしてく� さい。 詳細については、「ご利用の GitHub Pages サイトに合わせた公開元の構成」を参照してく� さい。 たとえば、既定ブランチの 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
    $ git rm -rf 
    # Removes the contents from your default branch from the working directory
  6. 新しい Jekyll サイトを作成するには、jekyll new コマンドを使用します。

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
  7. Jekyll が作成した Gemfile を開きます。

  8. gem "jekyll" で始まる行の先� �に「#」を追� して行をコメントアウトします。

  9. # gem "github-pages" で始まる行を編集して、github-pages gem を追� します。 行を次のように変更します。

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

    GITHUB-PAGES-VERSION を、サポートされる最新バージョンの github-pages gem で置き換えます。 このバージョンは、「依存関係のバージョン」にあります。

    正しいバージョンの Jekyll が、github-pages gem の依存関係としてインストールされます。

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

  11. コマンド ラインから bundle install を実行します。

  12. 必要に応じて、_config.yml ファイルに対して必要な編集を行います。 これは、リポジトリがサブディレクトリでホストされている� �合に相対パスに対して必要です。 詳細については、「サブフォルダーを新規リポジトリに分割する」を参照してく� さい。

    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
    
  13. 必要に応じて、サイトをローカルでテストします。 詳細については、「Jekyll を使用して GitHub Pages サイトをローカルでテストする」を参照してく� さい。

  14. 作業内容を追� してコミットしてく� さい。

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  15. リポジトリを にリモートとして追� します。HOSTNAME をエンタープライズのホスト名で、USER をリポジトリを所有するアカウントで、さらに REPOSITORY をリポジトリの名前で置き換えます。

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    
  16. リポジトリを GitHub Enterprise Server にプッシュします。BRANCH を作業対象のブランチの名前で置き換えます。

    $ git push -u origin BRANCH
  17. 公開ソースを設定してく� さい。 詳細については、「GitHub Pages サイトの公開元を設定する」を参照してく� さい。 1. GitHub Enterprise Serverで、サイトのリポジトリにアクセスしてく� さい。 1. リポジトリ名の下の [ 設定] をクリックします。 リポジトリの設定ボタン

  18. 左側のサイドバーで、 [ページ] をクリックします。 左側のサイドバーの [ページ] タブ 1. 公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてく� さい。 公開されたサイトの URL

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

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

次の手� �

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

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