Markdown記法チートシート

Markdownは、いくつかの記号でプレーンテキストを書式付きのHTMLに変えます。このチートシートは、ほとんどのツールが従う標準のCommonMarkと、表・タスクリスト・取り消し線・URLの自動リンクを加えたGitHub Flavored Markdownの記法を、例ごとの正確なHTML出力とともにまとめています。脚注やアラートボックスのようにGitHub.comだけがレンダリングする機能は別に表示してあるので、どこで動かないかが分かります。

使い方

1. 表をざっと見るか、フィルターに「表」や「リンク」などの単語を入力します。
2. 「表示」メニューで、CommonMark、GFM拡張、GitHub専用機能のいずれかに絞り込みます。
3. 「試してみる」に手持ちのMarkdownを貼り付けると、変換後のHTMLを確認できます。
4. HTMLをコピーするか、出力が思いどおりになるまでMarkdownを調整します。

計算式

Markdownテキスト → HTML（CommonMark + GFMのルール）

HTML列と「試してみる」欄は、ブラウザ上でmarkedライブラリのGFMモードを使って生成します。CommonMarkとGFMの仕様に忠実ですが、まれな境界ケースでは他のレンダラーと結果が異なることがあります。段落内の改行は、行末に空白2つかバックスラッシュがある場合にだけ<br>になります。

計算例

初期値のサンプルでは、- [x] 牛乳がチェック済みで無効化されたチェックボックスつきのリスト項目になり、食パンは<strong>食パン</strong>になります。区切り行| :--- | ---: |により、品目列は左揃え、数量列は右揃えになり、12にはalign="right"が付きます。npm testを囲むバッククォートは<code>npm test</code>になります。