このサイトは Nimbus(Astro ベース)で動く静的サイトです。ページはすべて src/content/docs/ 配下の MDX ファイルで、ファイルの木構造がそのまま URL とサイドバーになります。
前提
- Node 22.12 以上
- pnpm
手元で動かす
pnpm install
pnpm devhttp://localhost:4321/ が開きます。保存するとその場で反映されます。
ページを追加する
src/content/docs/に.mdxファイルを作る- frontmatter に
titleを書く - 保存する
title は必須で、それ以外は任意です。sidebar.order を書くとサイドバー内の並び順を固定できます。
公開前に確認する
pnpm lint:docs
pnpm buildlint:docs はリンク切れ・frontmatter の形・見出しの階層を検査します。--fix を付けると直せるものは自動で直ります。
構成
| パス | 中身 |
|---|---|
src/content/docs/ |
記事本体(MDX) |
src/components/ui/ |
部品(Aside、Steps、Tabs など) |
src/styles/ |
デザイントークンと本文スタイル |
astro.config.ts |
サイト名、説明、サイドバー構成 |
nimbus.json |
Nimbus CLI が管理する導入記録(コミットする) |
出典
- 「ファイルパスが URL とサイドバーになる」構成: https://nimbus-docs.com/project-structure/
lint:docsが検査する項目: https://nimbus-docs.com/cli/index.md