GitHubリポジトリからドキュメントをホスティングする方法

GitHubリポジトリにMarkdownファイルがあります。それらを、検索可能で、ブランドに合わせてカスタマイズされ、Googleにインデックス登録され、モバイルでも読みやすい実際のURLで公開したいとします。リポジトリが信頼できる唯一の情報源であり、Webサイトはその表層です。

そこに到達するための一般的な方法は3つあります。このチュートリアルでは、それぞれの方法について、実際の設定手順とトレードオフを説明します。

すでに何を持っていますか？#

一般的なドキュメントリポジトリは次のようになっています：

my-product/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api-reference.md
│   └── guides/
│       └── webhooks.md

これをウェブサイトにしたい場合、現実的な選択肢は次の3つです：

GitHub Pagesは、リポジトリのブランチから静的サイトを無料で提供します。_config.ymlがあると、Jekyllを認識してMarkdownをレンダリングします。

リポジトリのルートに_config.ymlを作成します:
```
theme: jekyll-theme-minimal
title: My Product Docs
```
リポジトリの設定 → Pagesに移動します
ソースをmainブランチの/docsフォルダーに設定します
数分待つと、サイトがusername.github.io/repoで公開されます

社内Wikiには適しています。ドキュメントを顧客向けのプロダクトの一部として提供する場合には適していません。

Docusaurusは、Metaのオープンソースのドキュメントフレームワークです。Reactベースで、個々のコンポーネントに至るまでテーマをカスタマイズできます。ただし、その保守を引き受ける覚悟があればの話です。

プロジェクトを初期構築する:

npx create-docusaurus@latest my-docs classic
cd my-docs

ドキュメント自体がチームで所有し、公開するプロダクトである場合には適しています。ドキュメントをオンラインで公開したいだけの場合には、負担が大きくなります。

Docsbook は、GitHub リポジトリを瞬時にドキュメントサイトへ変換するマネージドプラットフォームです。CI/CD、設定ファイル、ビルドパイプラインは一切必要ありません。

これだけです。main への git push ごとに、サイトが自動的に更新されます。

レンダリングパイプラインを所有することはできませんが、Markdownはリポジトリに残るため、ロックインされることはありません。いつでもキャンセルでき、ドキュメントも一緒に持ち出せます。

用途	選択肢
個人プロジェクト、社内ウィキ	GitHub Pages
フロントエンドチームがあり、デザインにこだわりがある	Docusaurus
今日の午後からドキュメントを公開し、SEOにも対応したい	Docsbook

率直に言うと、ドキュメントが製品そのものでないなら、ドキュメントプラットフォームを構築しないでください。既存のものを使いましょう。

GitHub からドキュメントをホスティングするには、以前は設定リポジトリ、デプロイパイプライン、そして定期的なクリーンアップが必要でした。リポジトリの URL を貼り付けるだけでサイトが公開されます。Markdown がリポジトリの外に出ることはないため、移行は元に戻せます。

Updated Sep 3, 2026