#Static Site
25 件の記事
Docusaurusでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化
シリーズの最終回です。Docusaurusに検索をきちんと付け、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かしておくDocs as Code文化まで、運用の観点を整理してシリーズを締めくくります。
MkDocsでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化
シリーズの最終回です。Materialの内蔵検索を整え、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かし続けるDocs as Code文化まで、運用の観点を整理してシリーズを締めくくります。
Starlightでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化
シリーズの最終回です。標準で組み込まれたStarlightの検索を押さえ、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生き続けさせるDocs as Code文化まで、運用の観点を整理してシリーズを締めくくります。
ドキュメントサイトジェネレーター比較 — Hugo・MkDocs・Docusaurus・Starlight、どれを選ぶか
チームのドキュメントを静的サイトで作ると決めたら、次の問いはどのツールで作るかです。Hugo・MkDocs・Docusaurus・Starlight の4つをランタイム・検索・バージョン管理・天井の観点で比較し、状況別に何を選べばよいかを整理します。
Docusaurusでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品のバージョンが上がるときに古いドキュメントも一緒に維持する方法を扱います。多言語とバージョン管理をどちらも標準機能として備えた、Docusaurusが最も強い領域です。
Hugoでマニュアルを作る #6 メンテナンス — 検索インデックス、アクセシビリティ、ドキュメント文化
シリーズの最終回です。規模が大きくなったドキュメントのための Pagefind 検索インデックス、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かしておく Docs as Code 文化まで、運用の観点を整理してシリーズを締めくくります。
MkDocsでマニュアルを作る #5 多言語とバージョン管理
ひとつのドキュメントを複数の言語で提供し、製品バージョンが上がったときに古いドキュメントを一緒に維持する方法を扱います。mkdocs-static-i18nプラグインで多言語を、mikeでバージョンスナップショットとバージョンセレクターを付けるところまで整理します。
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も併せて押さえます。
Starlightでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHubに上げ、Cloudflare Pagesに接続してAstroのビルドを設定し、カスタムドメインを付ける過程を整理します。