Markdown記法チートシート・早見表
使いたい書式を探して例をコピーし、レンダリング結果を確認できます。基本記法とGFM拡張の違いもまとめています。
1分で分かるMarkdown
Markdownは、記号を使って文章の構造を表します。見出しには#、太字には**、リストには-、リンクには角括弧と丸括弧を使います。表、タスクリスト、取り消し線はGFMなどの拡張機能に依存します。
この早見表の使い方
- 1早見表から使いたい書式を探します。
- 2記法をコピーし、例文を自分の文章に置き換えます。
- 3エディターに貼り付け、プレビューで確認します。
よく使うMarkdown記法
記法をコピーし、サンプルの文字を自分の内容に置き換えてください。
| 用途 | 記法 | 表示結果 | コピー |
|---|---|---|---|
| 見出し1 | # 見出し1 | 見出し1 | |
| 見出し2 | ## 見出し2 | 見出し2 | |
| 太字 | **太字** | 太字 | |
| 斜体 | *斜体* | 斜体 | |
| 取り消し線GFM | ~~削除した文字~~ | ||
| リンク | [ilovemd](https://ilovemd.net) | ilovemd | |
| 画像 |  | 代替テキスト付き画像 | |
| 箇条書き | - 1つ目の項目 | • 1つ目の項目 | |
| 番号付きリスト | 1. 最初の手順 | 1. 最初の手順 | |
| タスクリストGFM | - [ ] 記事を下書き | ☐ 記事を下書き | |
| 引用 | > 引用文 | 引用文 | |
| インラインコード | `npm run build` | npm run build | |
| コードブロック | ```js
console.log("こんにちは");
``` | コードブロック | |
| 表GFM | | A | B |
|---|---|
| 1 | 2 | | 2列の表 | |
| 水平線 | --- | 区切り線 | |
| 改行 | 1行目
2行目 | 2行 | |
| エスケープ | \*斜体にならない\* | *斜体にならない* |
見出し
見出しは文字を大きくするためではなく、文書の階層を示すために使います。H1は1つ、主要な章はH2、その中の小見出しはH3にすると読みやすくなります。
# プロジェクトガイド
## インストール
### macOS
### Windows太字・斜体・取り消し線
意味を伝える短い語句だけを強調すると、文章を拾い読みしやすくなります。取り消し線はGFM拡張なので、表示できない環境もあります。
**重要な文字**
*強調する文字*
***太字かつ斜体***
~~削除した文字~~リストとタスクリスト
順不同の項目にはハイフン、手順には数字を使います。チェックボックス付きのタスクリストはGFM拡張です。
1. パッケージをインストール
2. 設定を更新
3. ビルドを実行
- [x] 下書きを作成
- [ ] リンクを確認
- [ ] ページを公開リンクと画像
リンク文字列には移動先が分かる言葉を使います。画像の代替テキストには、ファイル名ではなく画像の内容や役割を書いてください。
[MarkdownからPDFへの変換ツール](/ja/markdown-to-pdf)を開く。
インラインコードとコードブロック
コマンドやファイル名は1つのバッククォートで囲みます。複数行は3つのバッククォートで囲み、必要なら言語名を加えます。
公開前に `npm run build` を実行します。
```javascript
const message = "こんにちは、Markdown";
console.log(message);
```表と配置
セル内の文章は短くします。区切り行の左、両側、右にコロンを置くと、列ごとの左揃え・中央揃え・右揃えを指定できます。
| 形式 | 編集可能 | 主な用途 |
| :--- | :---: | ---: |
| DOCX | はい | 共同編集 |
| PDF | いいえ | 共有 |
| HTML | はい | Web公開 |改行とエスケープ
通常の改行だけでは同じ段落になることがあります。行末に半角スペースを2つ入れると強制改行、空行を入れると別の段落になります。記号をそのまま表示するときは直前にバックスラッシュを置きます。
改行する1行目。
2行目。
新しい段落。
\*アスタリスクをそのまま表示。\*CommonMarkとGitHub Flavored Markdown
Markdownには共通の基本記法がありますが、拡張記法はすべての環境で使えるとは限りません。公開先のエディターやCMSの対応状況を確認してください。
見出し、段落、強調、引用、リスト、コード、リンク、画像、水平線は、CommonMark互換パーサーで広く使える基本記法です。
GitHub Flavored Markdownは、表、タスクリスト、取り消し線、拡張オートリンクを追加します。他のエディターでは一部だけに対応している場合があります。
正確な解析規則は、CommonMark仕様とGitHub Flavored Markdown仕様で確認できます。 CommonMark · GFM
よくある間違い
意図した表示にならないときは、ツールを変える前に記法の構造と公開先の互換性を確認します。
- リスト、表、コードブロックの前に空行を入れる。
- 強調記号とコードフェンスを必ず閉じる。
- 表の見出し行の下に区切り行を置く。
- 入れ子のリストではインデント幅を揃える。
- 公開先がGFM拡張に対応しているか確認する。
- 画像のパスを有効に保ち、内容が伝わる代替テキストを書く。
Markdown記法のよくある質問
Markdown記法はどのサービスでも同じですか？
基本記法は多くの環境で共通です。表、タスクリスト、取り消し線はGFMなどの拡張機能に依存します。
Markdownで表を作るには？
見出し行、ハイフンの区切り行、データ行をパイプで区切ります。CSVやTSVから作る場合は表ジェネレーターも使えます。
書いたMarkdownを確認する方法は？
例をilovemdのエディターへ貼り付け、リッチプレビューでレンダリング結果を確認してください。
Markdownファイルの拡張子は何ですか？
一般的な拡張子は.mdです。.markdownに対応するアプリもありますが、通常は.mdの方が扱いやすいです。
記号を文字として表示するには？
記号の直前にバックスラッシュを置きます。たとえば\*文字\*と書くと、アスタリスクが斜体の記号として解釈されません。