レッスン 3
GitHub Flavored Markdown 日本語ガイド
GFM の表、フェンスコードブロック、タスクリスト、その他 GitHub 向け拡張を扱います。
GitHub Flavored Markdown（GFM）は、README や Issue で開発者が依存する機能で基本 Markdown を拡張します。
表
| Tool | Purpose |
| --- | --- |
| JSON Formatter | Validate API payloads |
| Markdown Preview | Draft README files |
表は機能リスト、互換性マトリクス、クイック比較に有用です。
言語タグ付きフェンスコードブロック
```json
{
"status": "ok"
}
```
言語タグはレンダラーに構文スタイルを適用させ、読者がスニペットの種類をすぐ理解するのに役立ちます。
タスクリスト
- [x] add endpoint
- [ ] update docs
- [ ] add regression test
タスクリストは Issue テンプレートや PR チェックリストで一般的です。
取り消し線
~~deprecated option~~
削除された設定キーや非推奨 API フィールドのドキュメント化に有用です。
GFM がどこでも保証されない
すべての Markdown レンダラーがすべての GFM 機能をサポートするわけではありません。公開前に：
- ターゲットプラットフォームが表とタスクリストをサポートするか確認する
- ドキュメントが複数システムでレンダリングされる必要がある場合は、エキゾチックな拡張を避ける
要点
GFM はほとんどの GitHub README と Issue コンテンツの背後にある方言です。GitHub 向けに書くなら、表、フェンスコードブロック、タスクリストは通常安全な選択です。
README や Issue テンプレートをコミットする前に、Markdown Preview / Markdown to HTML ツールで GFM サンプルをプレビューしてください。