#Hugo
7 件の記事
ドキュメントサイトジェネレーター比較 — Hugo・MkDocs・Docusaurus・Starlight、どれを選ぶか
チームのドキュメントを静的サイトで作ると決めたら、次の問いはどのツールで作るかです。Hugo・MkDocs・Docusaurus・Starlight の4つをランタイム・検索・バージョン管理・天井の観点で比較し、状況別に何を選べばよいかを整理します。
Hugoでマニュアルを作る #6 メンテナンス — 検索インデックス、アクセシビリティ、ドキュメント文化
シリーズの最終回です。規模が大きくなったドキュメントのための Pagefind 検索インデックス、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生かしておく Docs as Code 文化まで、運用の観点を整理してシリーズを締めくくります。
Hugoでマニュアルを作る #5 多言語とバージョン管理
一つのドキュメントを複数の言語で提供し、製品のバージョンが上がるときに古いドキュメントを一緒に維持する方法を扱います。Hugo の多言語設定と翻訳の接続、そして Hugo に標準機能がないバージョン管理をフォルダで解く現実的な方法を整理します。
Hugoでマニュアルを作る #4 Cloudflare Pages でデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHub に上げ、Cloudflare Pages に接続してビルド設定を整え、カスタムドメインを付ける過程を整理します。Hextra の Go モジュールと公開日の落とし穴まで一緒に押さえます。
Hugoでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、コールアウト
ドキュメントを読みやすくする三つの要素を扱います。ファイル名・行ハイライトが付くコードブロック、コードで描く Mermaid のダイアグラム、そして注意・警告を目立たせて見せるコールアウトまで、Hextra での使い方を整理します。
Hugoでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を整える
ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が要です。Hextra でフォルダ構造によってサイドバーの階層を整え、weight で順序を決め、上部メニューと内蔵検索を接続するところまで整理します。
Hugoでマニュアルを作る #1 インストールから最初のドキュメントまで
Hugo と Hextra テーマでチームドキュメント・製品マニュアルサイトの骨格を立てます。Hugo Extended と Go のインストールから、新しいサイトの作成、テーマの接続、ローカルサーバーで最初のドキュメントを表示するところまで一気に進めます。