リファレンス
Markdownチートシート
Markdownの主要な構文と、それが生成するHTML、そしてその表示結果です。サンプルはビルド時に、このコンバーターと同じエンジンでリアルタイムに変換されています。
見出し
#を1〜6個使用します。
Markdown
# Heading 1 ## Heading 2 ### Heading 3
HTML
<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>表示結果
Heading 1
Heading 2
Heading 3
太字・斜体・取り消し線
取り消し線にはGFMが必要です。
Markdown
**bold**, *italic*, ***both***, ~~strikethrough~~
HTML
<p><strong>bold</strong>, <em>italic</em>, <em><strong>both</strong></em>, <del>strikethrough</del></p>表示結果
bold, italic, both, strikethrough
リンク
インラインリンク、タイトル付きリンク、自動リンク。
Markdown
[Inline link](https://example.com) [With a title](https://example.com "Example") https://example.com
HTML
<p><a href="https://example.com">Inline link</a></p>
<p><a href="https://example.com" title="Example">With a title</a></p>
<p><a href="https://example.com">https://example.com</a></p>画像
リンクと同じ記法で、先頭に!を付けます。
Markdown
HTML
<p><img src="/favicon.svg" alt="Site logo"></p>表示結果
箇条書きリスト
-、*、+のいずれかを使用。ネストするには半角スペース2つでインデントします。
Markdown
- Apples - Oranges - Blood orange - Pears
HTML
<ul>
<li>Apples</li>
<li>Oranges
<ul>
<li>Blood orange</li>
</ul>
</li>
<li>Pears</li>
</ul>表示結果
- Apples
- Oranges
- Blood orange
- Pears
番号付きリスト
番号は連番である必要はありません。
Markdown
1. First 2. Second 3. Third
HTML
<ol>
<li>First</li>
<li>Second</li>
<li>Third</li>
</ol>表示結果
- First
- Second
- Third
タスクリスト
GFMのチェックボックス記法です。
Markdown
- [x] Write the draft - [ ] Publish it
HTML
<ul>
<li><input checked="" disabled="" type="checkbox"> Write the draft</li>
<li><input disabled="" type="checkbox"> Publish it</li>
</ul>表示結果
- Write the draft
- Publish it
引用
行の先頭に>を付けます。
Markdown
> Simple is better > than complex.
HTML
<blockquote>
<p>Simple is better
than complex.</p>
</blockquote>表示結果
Simple is better than complex.
インラインコード
バッククォートで囲みます。
Markdown
Run `npm install` first.
HTML
<p>Run <code>npm install</code> first.</p>表示結果
Run npm install first.
フェンス付きコードブロック
開始フェンスの後に言語名を書くとハイライトされます。
Markdown
```js const answer = 42; ```
HTML
<pre><code class="hljs language-js"><span class="hljs-keyword">const</span> answer = <span class="hljs-number">42</span>;
</code></pre>表示結果
const answer = 42;
テーブル
GFM機能です。区切り行のコロンで揃え位置を指定します。
Markdown
| Name | Qty | | ---- | --: | | Tea | 2 | | Milk | 10 |
HTML
<table>
<thead>
<tr>
<th>Name</th>
<th align="right">Qty</th>
</tr>
</thead>
<tbody>
<tr>
<td>Tea</td>
<td align="right">2</td>
</tr>
<tr>
<td>Milk</td>
<td align="right">10</td>
</tr>
</tbody>
</table>表示結果
| Name | Qty |
|---|---|
| Tea | 2 |
| Milk | 10 |
水平線
-、*、_のいずれかを3個以上使用します。
Markdown
Above --- Below
HTML
<p>Above</p>
<hr>
<p>Below</p>表示結果
Above
Below
改行
行末に半角スペース2つかバックスラッシュを付けるか、「改行を<br>に変換」を有効にします。
Markdown
First line\ Second line
HTML
<p>First line<br>Second line</p>表示結果
First line
Second line
エスケープ
バックスラッシュで特殊文字をエスケープします。
Markdown
\*not italic\*
HTML
<p>*not italic*</p>表示結果
*not italic*
コアMarkdownに含まれない機能
脚注、定義リスト、数式、絵文字ショートコードは、このコンバーターが処理しない拡張機能です。Markdown内の生のHTMLは、Sanitize HTMLがオフの場合はそのまま出力され、オンの場合はクリーンにされます。