ノート: 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 Server上にあるプロジェクトのドキュメンテーションを公開するサイトを作成しているなら、そのサイトのソースコードはプロジェクトと同じリポジトリに保存したいでしょう。
既存のリポジトリにサイトを作成したいのなら、サイトの作成セクションまでスキップしてく� さい。
- ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してく� さい。
- Owner(オーナー)ドロップダウンメニューを使い、リポジトリを所有したいアカウントを選択してく� さい。
- リポジトリの名前と、任意で説明を入力してく� さい。 ユーザもしくは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 Server上にサイトのためのリポジトリを持っていなければなりません。 既存のリポジトリ内にサイトを作成しようとしているのではないなら、「サイトのためのリポジトリの作成」を参照してく� さい。
Warning: If your site administrator has enabled Public Pages, GitHub Pages sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "Configuring GitHub Pages for your enterprise" and "About repositories."
-
ターミナルターミナル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 Enterprise Serverインスタンスでリモートとしてリポジトリを追� してく� さい。HOSTNAMEをEnterpriseのホスト名で、USERをリポジトリを所有するアカウントで、REPOSITORYをリポジトリ名で置き換えてく� さい。
$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
-
リポジトリを GitHub Enterprise Server にプッシュします。 BRANCH は、作業を行なっているブランチの名前に置き換えてく� さい。
$ git push -u origin BRANCH
-
公開ソースを設定してく� さい。 詳しい情� �については「GitHub Pages サイトの公開元を設定する」を参照してく� さい。
-
GitHub Enterprise Serverで、サイトのリポジトリにアクセスしてく� さい。
-
リポジトリ名の下で Settings(設定)をクリックしてく� さい。
-
左のサイドバーでPages(ページ)をクリックしてく� さい。
-
公開されたサイトを見るには、"GitHub Pages"の下で、サイトのURLをクリックしてく� さい。
メモ: サイトに対する変更は、その変更をGitHub Enterprise Serverにプッシュしてから公開されるまでに、最大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 サイトにテーマを追� する」を参照してく� さい。