フレームワーク
ドキュメントサイトジェネレーター比較 — Hugo・MkDocs・Docusaurus・Starlight、どれを選ぶか
チームのドキュメントを静的サイトで作ると決めたら、次の問いはどのツールで作るかです。Hugo・MkDocs・Docusaurus・Starlight の4つをランタイム・検索・バージョン管理・天井の観点で比較し、状況別に何を選べばよいかを整理します。
Docusaurusでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品のバージョンが上がるときに古いドキュメントも一緒に維持する方法を扱います。多言語とバージョン管理をどちらも標準機能として備えた、Docusaurusが最も強い領域です。
Hugoでマニュアルを作る #6 メンテナンス — 検索インデックス、アクセシビリティ、ドキュメント文化
シリーズの最終回です。規模が大きくなったドキュメントのための Pagefind 検索インデックス、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かしておく Docs as Code 文化まで、運用の観点を整理してシリーズを締めくくります。
MkDocsでマニュアルを作る #5 多言語とバージョン管理
ひとつのドキュメントを複数の言語で提供し、製品バージョンが上がったときに古いドキュメントを一緒に維持する方法を扱います。mkdocs-static-i18nプラグインで多言語を、mikeでバージョンスナップショットとバージョンセレクターを付けるところまで整理します。
React状態管理の深掘り #4 Jotaiと原子（atom）モデル
状態を1つのストアではなく小さな原子に分けて組み立てる、Jotaiのボトムアップモデルを扱います。原子、派生原子、useAtomの挙動と、Zustandとの違いを整理します。
Starlightでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品バージョンが上がるときに古いドキュメントを一緒に維持する方法を扱います。多言語はStarlightが標準で組み込み、バージョン管理はプラグインで加えます。
Docusaurusでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHubに上げ、Cloudflare Pagesに接続してNodeのビルドを設定し、カスタムドメインを付ける過程を整理します。Docusaurus標準のデプロイであるdeployコマンドも併せて押さえます。
Hugoでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品のバージョンが上がるときに古いドキュメントを一緒に維持する方法を扱います。Hugo の多言語設定と翻訳の接続、そして Hugo に標準機能がないバージョン管理をフォルダで解く現実的な方法を整理します。
MkDocsでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインをつなぐ
ローカルで作ったドキュメントを世に送り出します。requirements.txtで依存関係を固定し、GitHubに上げてCloudflare Pagesにつなぎ、カスタムドメインを付ける過程を整理します。MkDocs標準のデプロイであるgh-deployも併せて押さえます。
React状態管理の深掘り #3 Zustandで扱う軽量なクライアント状態
Providerなしで、最小限のボイラープレートでグローバルなクライアント状態を共有するZustandを扱います。ストアの生成、セレクターによる再レンダリング最適化、persistミドルウェアまで整理します。
Starlightでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHubに上げ、Cloudflare Pagesに接続してAstroのビルドを設定し、カスタムドメインを付ける過程を整理します。
Docusaurusでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、admonition
ドキュメントを読みやすくする三つの要素を扱います。タイトル・行強調が付くコードブロック、コードで描くMermaidのダイアグラム、そして注意・警告を見せるadmonitionまで、Docusaurusでの使い方を整理します。