2. GitHub Pagesを使った簡単な情報発信方法
GitHub Pages(ギットハブ・ページズ)は、GitHubから静的ウェブサイトをホスティングできるサービスです。リポジトリの内容(HTMLやMarkdown)をWebサイトとして公開することができます。利用は無料で、例えばプロジェクトの説明サイトや個人ブログ、ドキュメントサイトなどを簡単に公開できます。
ビジネスでの活用シーン
業務でGitHub Pagesを使うケースとしては、資料やマニュアルの社外公開、あるいは製品の説明サイトなどが考えられます。テキストと画像中心の簡単なページであれば、エンジニアに依頼せずともGitHub Pagesで十分作成可能です。
GitHub Pagesの基本利用手順
ブランチの指定
GitHub Pagesはリポジトリ内の特定のブランチ・フォルダをWebサイトとして公開します。通常、Settingsの「Pages」設定で、ソース(Source)としてmain
ブランチの/docs
フォルダ、またはgh-pages
ブランチなどを指定します。簡単なのは、リポジトリのSettings > PagesでBranchをmain、Folderをroot (or /docs)に設定し「Save」します。これでサイトがビルドされ、URL(例えば https://ユーザ名.github.io/リポジトリ名/
)が発行されます。
コンテンツの用意
公開したいHTML、Markdown、画像などをリポジトリに配置します。Markdown(.md)から自動でHTMLに変換するJekyllという仕組みがデフォルト有効ですので、シンプルなMarkdownを置くだけでもサイトになります。より凝ったサイトにしたければ、自分で静的HTML/CSSを用意することもできますが、本サイトでは割愛します。
公開確認
設定後しばらく(1分程度)すると、PagesのURLでサイトが見られるようになります。例えばREADME.mdがトップページとして表示されたり、/docsフォルダ内のindex.mdがトップになるなど、自動のルールがあります。うまく表示されない場合は、GitHub ActionsのPagesデプロイログ(Settings > Pagesに表示される)を確認しましょう。
【画像: GitHub Pagesの設定画面とデプロイ後のサイト例】
GitHub Pagesのメリット
自動更新機能
GitHub Pagesのメリットは、リポジトリを更新するだけでサイトも自動更新される点です。例えば製品マニュアルの文章をMarkdownで管理しておき、それをPagesで公開しておけば、GitHub上で修正するたび即座にウェブ上の公開版も更新されます。部署ブログ的な情報発信にも使えますし、採用情報サイトを簡易に作ることもできます。
注意点
注意点として、無料版では公開サイトは基本的に公開状態になります(プライベートにはできません)。社内限定公開にしたい場合、GitHub Enterpriseの機能や社内VPNと組み合わせる必要があります。ただ、社外に見せても問題ない情報であれば、無料のGitHub Pagesはコストゼロで活用可能です。
機能の制限
また、Pagesは静的サイトなので、例えばお問い合わせフォームのような動的機能はそのままでは実現できません。しかし会社紹介やドキュメント公開程度なら静的で十分でしょう。実際、多くのオープンソースプロジェクトがGitHub Pagesでドキュメントサイトを提供しています。
【画像: GitHub Pagesで作成された公開サイトの例】
カスタムドメインの設定
GitHub Pagesのサイトには、自分で所有しているドメイン名を設定することも可能です。例えば docs.mycompany.com
などのドメインをGitHub Pagesのサイトに向けることができます。設定方法は以下の手順です:
- リポジトリのSettings > Pagesの「Custom domain」欄に使用したいドメインを入力します
- DNSプロバイダの設定で、入力したドメインがGitHub Pagesを指すように設定します(CNAMEレコードの追加など)
- 「Enforce HTTPS」にチェックを入れて、セキュアな接続を確保します
カスタムドメインを設定すると、より専門的で信頼性の高いウェブサイトという印象を与えることができます。特に会社の公式サイトや製品ドキュメントサイトとして利用する場合は、カスタムドメインの設定をおすすめします。