#Starlight

6 件の記事

Starlightでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化
読了 4分

Starlightでマニュアルを作る #6 メンテナンス — 検索、アクセシビリティ、ドキュメント文化

シリーズの最終回です。標準で組み込まれたStarlightの検索を押さえ、誰もが読めるようにするアクセシビリティ、そしてドキュメントを長く生き続けさせるDocs as Code文化まで、運用の観点を整理してシリーズを締めくくります。

Starlightでマニュアルを作る #5 多言語とバージョン管理
読了 3分

Starlightでマニュアルを作る #5 多言語とバージョン管理

一つのドキュメントを複数の言語で提供し、製品バージョンが上がるときに古いドキュメントを一緒に維持する方法を扱います。多言語はStarlightが標準で組み込み、バージョン管理はプラグインで加えます。

Starlightでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する
読了 3分

Starlightでマニュアルを作る #4 Cloudflare Pagesでデプロイしてドメインを接続する

ローカルで作ったドキュメントを世に送り出します。GitHubに上げ、Cloudflare Pagesに接続してAstroのビルドを設定し、カスタムドメインを付ける過程を整理します。

Starlightでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、aside
読了 3分

Starlightでマニュアルを作る #3 コンテンツ作成 — コードブロック、Mermaid、aside

ドキュメントを読みやすくする三つの要素を扱います。タイトル・行強調が付くコードブロック、プラグインで加えるMermaidのダイアグラム、そして注意・警告を見せるasideまで、Starlightでの使い方を整理します。

Starlightでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を整える
読了 3分

Starlightでマニュアルを作る #2 サイドバーと検索 — ドキュメントの情報構造を整える

ドキュメントが数十編に増えても読者が道に迷わないためには、サイドバーと検索が肝心です。Starlightでサイドバーを自動・手動で構成し、標準で組み込まれた検索を見ていきます。

Starlightでマニュアルを作る #1 インストールから最初のドキュメントまで
読了 4分

Starlightでマニュアルを作る #1 インストールから最初のドキュメントまで

AstroのStarlightで、チームドキュメントや製品マニュアルサイトの土台を組み立てます。Node.jsの準備からcreate astroでサイトを生成し、開発サーバーで最初のドキュメントを表示するところまで一気に進めます。