Skip to main content

GitHub Pages サイトを作成する

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

GitHub Pagesは、GitHub Free及びOrganizationのGitHub Freeのパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Serverのパブリック及びプライベートリポジトリで利用できます。 詳しい情報については「GitHubの製品」を参照してください。

ノート: Organizationのオーナーは、Organizationが所有しているリポジトリからのGitHub Pagesサイトの公開を制限できます。 詳しい情報については「GitHub Pagesサイトの公開の管理」を参照してください。

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

You can either create a repository or choose an existing repository for your site.

If you want to create a GitHub Pages site for a repository where not all of the files in the repository are related to the site, you will be able to configure a publishing source for your site. For example, you can have a dedicated branch and folder to hold your site source files, or you can use a custom GitHub Actions workflow to build and deploy your site source files.

リポジトリを所有しているアカウントがGitHub FreeもしくはOrganization用のGitHub Freeを使用しているなら、そのリポジトリはパブリックでなければなりません。

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

  1. ページの右上角で ドロップダウンメニューを使い、New repository(新規リポジトリ)を選択してください。 新しいリポジトリを作成する選択肢を持つドロップダウン

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

    Note: If you're a 管理されているユーザアカウント, you can only publish GitHub Pages sites from repositories owned by organizations. 詳しい情報については、「GitHub Pages について」を参照してください。

  3. リポジトリの名前と、任意で説明を入力してください。 ユーザもしくはOrganizationのサイトを作成しているなら、リポジトリは<user>.github.ioもしくは<organization>.github.ioという名前でなければなりません。 If your user or organization name contains uppercase letters, you must lowercase the letters. 詳しい情報については「GitHub Pagesについて」を参照してください。 リポジトリ作成フィールド

  4. リポジトリの可視性を選択してください。 For more information, see "About repositories." リポジトリの可視性を選択するラジオボタン

  5. [Initialize this repository with a README] を選択します。 [Initialize this repository with a README] チェックボックス

  6. [Create repository] をクリックします。 Button to create repository

サイトを作成する

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

Warning: Unless your enterprise uses Enterprise Managed Users, GitHub Pages sites are publicly available on the internet by default, even if the repository for the site is private or internal. You can publish a site privately by managing access control for the site. Otherwise, if you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "About repositories" and "Changing the visibility of your GitHub Pages site."

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

  2. Decide which publishing source you want to use. For more information, see "Configuring a publishing source for your GitHub Pages site."

  3. Create the entry file for your site. GitHub Pages will look for an index.html, index.md, or README.md file as the entry file for your site.

    If your publishing source is a branch and folder, the entry file must be at the top level of the source folder on the source branch. For example, if your publishing source is the /docs folder on the main branch, your entry file must be located in the /docs folder on a branch called main.

    If your publishing source is a GitHub Actions workflow, the artifact that you deploy must include the entry file at the top level of the artifact. Instead of adding the entry file to your repository, you may choose to have your GitHub Actions workflow generate your entry file when the workflow runs.

  4. 公開ソースを設定してください。 詳しい情報については「GitHub Pages サイトの公開元を設定する」を参照してください。

  5. リポジトリ名の下で Settings(設定)をクリックしてください。 リポジトリの設定ボタン

  6. In the "Code and automation" section of the sidebar, click Pages.

  7. Optionally, if you're publishing a project site from a private or internal repository, choose the visibility for your site. Under "GitHub Pages", select the GitHub Pages visibility drop-down menu, then click a visibility. For more information, see "Changing the visibility of your GitHub Pages site". Drop-down to select visibility for your site

    ノート: GitHub Pagesサイトをプライベートで公開するには、OrganizationはGitHub Enterprise Cloudを使っていなければなりません。 For more information about how you can try GitHub Enterprise Cloud for free, see "Setting up a trial of GitHub Enterprise Cloud."

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

    メモ: サイトに対する変更は、その変更をGitHub Enterprise Cloudにプッシュしてから公開されるまでに、最大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 you are publishing from a branch and your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

次のステップ

新しいファイルを追加で作成することにより、ページを追加できます。 各ファイルは、公開元と同じディレクトリ構造で、サイト上に表示されます。 たとえば、プロジェクトサイトの公開元が gh-pages ブランチで、新しいファイル /about/contact-us.mdgh-pages ブランチに作成した場合、ファイルは https://<user>.github.io/<repository>/about/contact-us.html で表示されます。

また、サイトの見た目をカスタマイズするため、テーマを追加できます。 詳しい情報については、「テーマ選択画面で GitHub Pages サイトにテーマを追加する」を参照してください。

サイトを更にカスタマイズするには、Jekyll を使用できます。Jekyll は、GitHub Pages に組み込まれている静的サイトジェネレータです。 詳しい情報については、「GitHub Pages と Jekyll」を参照してください。

参考リンク