ウィキの書き方(執筆ガイド)
このディレクトリ(docs/wiki/)の Markdown が、Docusaurus の Docs として website/ からビルドされ、サイト上では /wiki/ 配下の URL になります。
ファイルを追加する
docs/wiki/に.mdまたは.mdxを追加する。- サイドバーは
website/sidebars.tsのwikiSidebar自動生成に従う(フォルダ階層がカテゴリになります)。 - 表示順を制御したい場合は、各ファイルの front matter に
sidebar_position(数値が小さいほど上)を書く。
よく使う front matter
Docusaurus のドキュメント用メタデータです。ファイル先頭の --- で囲みます。
| フィールド | 説明 |
|---|---|
sidebar_position | サイドバー内の並び(同階層での目安)。 |
sidebar_label | サイドバーに表示する短いタイトル。 |
title | ページタイトル(未指定時は最初の見出しなどから推測)。 |
slug | URL 末尾(未指定時はファイル名ベース)。 |
Markdown / MDX
- 通常の Markdown 記法が使えます。
.mdxにすると JSX コンポーネントを埋め込めます(必要になったら拡張子を.mdxに)。
Markdown 全般: Markdown features
画像・添付
静的ファイルは website/static/ に置き、本文からは /img/... のように 先頭スラッシュ付きで参照するのが一般的です。
詳細: Static assets
ローカルで確認する
cd website
bun install
bun run start
ブラウザで http://localhost:3000/wiki/ を開き、追加したページがサイドバーと URL に反映されているか確認します。
ビルド
cd website
bun run build
サイト設定を変えるとき
- サイト名・ナビ・フッター:
website/docusaurus.config.ts - サイドバー手動定義に切り替える場合:
website/sidebars.ts
Docusaurus の初期化は公式の Installation に沿い、bunx create-docusaurus@latest website classic -p bun -t(TypeScript テンプレート)を使用しています。