開発ドキュメント

はじめに

ドキュメントはAstro Starlightを使用して作成されています.

閲覧方法

ローカルで閲覧するために、以下のコマンドを実行してください.

cd docs
npm install
npm run dev

その後、ブラウザでhttp://localhost:4321にアクセスしてください.

更新方法

ドキュメントはMarkdown形式で作成されています. 新しいページを追加する場合は docs/src/content/<category>ディレクトリに新しいMarkdownファイルを作成してください. (開発ドキュメントの場合は,docs/src/content/development/ディレクトリに作成してください.)

ページのタイトルとサイドバーの順序を設定するために、Markdownファイルの先頭に以下のようなYAMLフロントマターを追加してください.

---
title: ページのタイトル
sidebar:
  order: サイドバーの順序番号
---

その他

Astro Mermaidを導入済みの為, Mermaid記法で図を作成することが可能です.