GitHub Flavored Markdown (GFM)
本ページでは、Methanol の Markdown/MDX 環境で利用可能な GitHub Flavored Markdown (GFM) の主要な機能を紹介します。
GFM とは
GFM は GitHub が策定・運用している Markdown の方言(拡張仕様)です。標準的な Markdown 記法に加え、技術執筆や共同作業に便利な以下の機能が追加されています。
主な機能拡張:
- 表(テーブル)
- タスクリスト(チェックボックス)
- 取り消し線(打消し線)
- 脚注
- 自動リンク(URL やメールアドレスの自動検知とリンク化)
Methanol では GFM が標準で有効化されています。機能を無効化したい場合は、設定ファイルで gfm: false を指定してください。
// methanol.config.js
export default () => ({
gfm: false
})
関連情報: 設定リファレンス
Markdown の処理プロセス(MDX/MD パース、スタイリング、テーマによるレンダリング)を検証する際のサンプルとして活用してください。
自動リンク(Autolink literals)
www.example.com, https://example.com, [email protected]
脚注(Footnote)
本文1
取り消し線(Strikethrough)
一つ または 二つ のチルダで囲みます。
表(Table)
| 項目 A | 項目 B | 項目 C | 項目 D |
|---|---|---|---|
| 左寄せ | 中央 | 中央 | 右寄せ |
| 1 | 2 | 3 | 4 |
タスクリスト(Tasklist)
- 未完了タスク
- 完了済みタスク
Footnotes
-
脚注の詳細な説明文。 ↩