共有する文書のための Markdown 実用チートシート
小さな文書を使い、見出し、強調、リスト、引用、リンク、表、タスク、コードの書き方を確認します。子項目や記号の表示、入れ子のフェンスも例示。基本構文と GFM 拡張を区別し、出力画像で構造と読みやすさを比べます。
役立つチートシートは、すべての Markdown 方言を暗記するためではなく、文書を仕上げるために使うものです。執筆中に Markdown チートシートを開き、このガイドで日常的な構文と表示結果を確認してください。ここでは一般的な文書の要素を扱います。数式や図は専用の資料を参照しましょう。
次の例には、見出し、行内スタイル、リスト、引用、リンク、表、タスクが含まれています。記号を1つずつ試すより、全体をコピーして組み合わせを見ると関係が分かります。
# Markdown field guide
## Inline text
**Bold**, *emphasis*, and `inline code`.
## Lists
- First item
- Second item
> A short quotation.
[Documentation](https://spec.commonmark.org/current/)
| Item | State |
|:--|:--|
| Draft | Reviewed |
- [x] GFM task list
出力画像で視覚的な階層を確認できます。Markdown も保存してください。原稿なら文章とリンク先を編集できますが、PNG は見た目のコピーです。
- 節：
#、##、###の後に空白を入れると、順に階層の低い見出しになります。カードでの文字サイズではなく、文書の構造で見出しの階層を選びます。 - 行内の意味：
**bold**は重要な語句を強く、*emphasis*は軽く強調します。短いコード識別子はバッククォートで囲みます。段落全体を太字にするのは避けましょう。 - リスト： 箇条書きには
-、手順には数字とピリオド、空白を使います。子項目は親の下にインデントします。ブロック間の空行は原稿を確認しやすくします。 - 引用： 行頭に
>を付けます。他人の言葉を引用する場合は、近くに出典を示してください。 - リンクと画像：
[label](URL)はリンクです。先頭に感嘆符を付けると画像の構文になり、角括弧内は画像の説明になります。
表、タスクリスト、取り消し線は GFM の拡張で、すべての Markdown レンダラーが対応するとは限りません。CommonMark 仕様と GFM 仕様で基本構文と拡張を区別できます。実際の使用先でプレビューしてください。
次の例では、子項目のある番号付きリスト、文字としてのアスタリスク、区切り線、フェンス付きコードブロックを追加します。外側を4つのバッククォートで囲むことで、内側の3つのバッククォートをそのまま表示しています。
### A smaller section
1. Review the draft
- Check the facts
2. Export the result
~~Old wording~~ and \*literal asterisks\*.
---
```javascript
console.log("Ready");
```
コードフェンスの後の言語指定は、ハイライトの選択に役立ちます。プログラムを実行したり、正しさを検証したりするものではありません。
構文を確認したら、Markdown コンバーターに貼り付けます。最長の行や表を読みやすく表示できる幅を選びましょう。エディターのプレビューだけでなく、ダウンロードしたファイルも確認します。画像の Markdown リンクはクリックできないため、重要なリンクは添える本文に残します。
対話式チートシートを手元に置く。具体的な不具合は Markdown のよくあるミス、長い例やフェンスの扱いはコードブロックのガイドを参照してください。