ドキュメント記法ガイド

このサイトで使える Markdown 拡張機能の一覧です。

Admonitions（注釈ボックス）

重要な情報を目立たせるボックスです。

注記

補足情報や参考情報に使います。

ヒント

おすすめの方法やベストプラクティスに使います。

警告

注意が必要な事項に使います。

危険

破壊的変更や重大なリスクに使います。

備考

情報提供に使います。

タイトル付きボックス

リリース前に確認

staging 環境で動作確認を済ませてから本番リリースしてください。

---

Tabs（タブ切り替え）

環境別のコマンドや手順を切り替えて表示できます。

Staging

pnpm run release:stg

Production

pnpm run release:patch

---

Code Blocks 拡張

タイトル付きコードブロック

packages/backend/src/example.ts

export const hello = (name: string) => `Hello, ${name}!`;

行ハイライト

月次レポート用クエリ

SELECT
  u.name,
  COUNT(r.id) AS receipt_count,
  SUM(r.amount) AS total_amount,
  MAX(r.created_at) AS last_receipt_at
FROM users u
LEFT JOIN receipts r ON r.user_id = u.id
GROUP BY u.id;

差分表示

export function processReceipt(data: ReceiptData) {
// highlight-remove-line
  const result = oldProcess(data);
// highlight-add-line
  const result = newProcess(data);
  return result;
}

---

Mermaid 図

フローチャート

シーケンス図

ER図

---

数式（KaTeX）

インライン数式: $E = mc^2$

ブロック数式:

$$\sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n$$