#Docusaurus
7 件の記事
Docusaurusでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化
シリーズの最終回です。Docusaurusに検索をきちんと付け、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かしておくDocs as Code文化まで、運用の観点を整理してシリーズを締めくくります。
ドキュメントサイトジェネレーター比較 — Hugo・MkDocs・Docusaurus・Starlight、どれを選ぶか
チームのドキュメントを静的サイトで作ると決めたら、次の問いはどのツールで作るかです。Hugo・MkDocs・Docusaurus・Starlight の4つをランタイム・検索・バージョン管理・天井の観点で比較し、状況別に何を選べばよいかを整理します。
Docusaurusでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品のバージョンが上がるときに古いドキュメントも一緒に維持する方法を扱います。多言語とバージョン管理をどちらも標準機能として備えた、Docusaurusが最も強い領域です。
Docusaurusでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHubに上げ、Cloudflare Pagesに接続してNodeのビルドを設定し、カスタムドメインを付ける過程を整理します。Docusaurus標準のデプロイであるdeployコマンドも併せて押さえます。
Docusaurusでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、admonition
ドキュメントを読みやすくする三つの要素を扱います。タイトル・行強調が付くコードブロック、コードで描くMermaidのダイアグラム、そして注意・警告を見せるadmonitionまで、Docusaurusでの使い方を整理します。
Docusaurusでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を組む
ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が核心です。Docusaurusでsidebars.jsを使ってサイドバーを自動・手動で構成し、検索を付ける選択肢を整理します。
Docusaurusでマニュアルを作る #1 インストールから最初のドキュメントまで
Docusaurusでチームドキュメントや製品マニュアルのサイトの骨組みを立てます。Node.jsの準備からcreate-docusaurusでサイトを生成し、開発サーバーで最初のドキュメントを表示するところまで一気に進めます。