#フレームワーク
129 件の記事
Hugoでマニュアルを作る #4 Cloudflare Pages でデプロイしてドメインを接続する
ローカルで作ったドキュメントを世に送り出します。GitHub に上げ、Cloudflare Pages に接続してビルド設定を整え、カスタムドメインを付ける過程を整理します。Hextra の Go モジュールと公開日の落とし穴まで一緒に押さえます。
MkDocsでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、admonition
ドキュメントを読みやすくする3つの要素を扱います。タイトルや行ハイライトが付くコードブロック、コードで描くMermaidの図、そして注意・警告を目立つように見せるadmonitionまで、MkDocs Materialでの使い方を整理します。
React状態管理の深掘り #2 TanStack Queryで扱うサーバー状態
useEffectとuseStateで書いていたデータ取得をTanStack Queryに移すと、キャッシュ、再取得、ローディングとエラー処理が自動で付いてきます。useQueryとuseMutationの核心を整理します。
Starlightでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、aside
ドキュメントを読みやすくする三つの要素を扱います。タイトル・行強調が付くコードブロック、プラグインで加えるMermaidのダイアグラム、そして注意・警告を見せるasideまで、Starlightでの使い方を整理します。
Docusaurusでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を組む
ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が核心です。Docusaurusでsidebars.jsを使ってサイドバーを自動・手動で構成し、検索を付ける選択肢を整理します。
Hugoでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、コールアウト
ドキュメントを読みやすくする三つの要素を扱います。ファイル名・行ハイライトが付くコードブロック、コードで描く Mermaid のダイアグラム、そして注意・警告を目立たせて見せるコールアウトまで、Hextra での使い方を整理します。
MkDocsでマニュアルを作る #2 navと検索 — ドキュメントの情報構造を整える
ドキュメントが数十編に増えても読者が迷わないためには、サイドバーと検索が要です。MkDocsでnavをmkdocs.ymlに直接設計し、Materialのナビゲーション機能と内蔵検索をオンにするところまで整理します。
React状態管理の深掘り #1 クライアント状態とサーバー状態の違い
useStateだけでは足りなくなる地点を押さえ、クライアント状態とサーバー状態を区別するメンタルモデルを立てます。状態管理ツールを選ぶ出発点です。
Starlightでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を整える
ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が肝心です。Starlightでサイドバーを自動・手動で構成し、標準で組み込まれた検索を見ていきます。
Docusaurusでマニュアルを作る #1 インストールから最初のドキュメントまで
Docusaurusでチームドキュメントや製品マニュアルのサイトの骨組みを立てます。Node.jsの準備からcreate-docusaurusでサイトを生成し、開発サーバーで最初のドキュメントを表示するところまで一気に進めます。
Hugoでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を整える
ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が要です。Hextra でフォルダ構造によってサイドバーの階層を整え、weight で順序を決め、上部メニューと内蔵検索を接続するところまで整理します。
MkDocsでマニュアルを作る #1 インストールから最初のドキュメントまで
MkDocsとMaterialテーマで、チームドキュメントや製品マニュアルのサイトの骨組みを立てます。Pythonの仮想環境へのインストールから、新しいサイトの作成、テーマの適用、ローカルサーバーで最初のドキュメントを表示するところまでを一気に進めます。