MarkdownLab

Markdownチートシート

基本的なMarkdown要素と代表的なGitHub Flavored Markdown(GFM)拡張のすべてを、コピーできるスニペットと実際の表示結果つきで紹介します。

その場で構文を試してみたいですか? Markdownエディタ を開けば、入力しながらリアルタイムでサニタイズ済みのプレビューを確認できます。

基本構文

すべてのMarkdownパーサーが対応している、CommonMarkのコア要素です。

ElementMarkdownResult
Heading# Heading 1 ## Heading 2 ### Heading 3Heading 1
Bold**bold text**bold text
Italic*italic text*italic text
Bold and italic***bold and italic***bold and italic
Blockquote> Quoted textQuoted text
Ordered list1. First item 2. Second item 3. Third item
  1. First item
  2. Second item
Unordered list- First item - Second item
  • First item
  • Second item
Inline code`code`code
Horizontal rule---
Link[title](https://example.com)title
Image![alt text](image.png)alt text (renders the image)

拡張構文(GitHub Flavored Markdown)

これらの拡張機能はコアのCommonMarkには含まれていませんが、GitHubやほとんどのチャットアプリ、このサイトのすべてのツールでサポートされています。

テーブル

パイプ記号で列を区切り、2行目のコロンで列の配置を指定します。

| Left | Center | Right |
| :--- | :---: | ---: |
| a | b | c |
LeftCenterRight
abc

タスクリスト

ダッシュ、チェックボックス、スペースの順に書きます——チェック済みの項目はxを使います。

- [x] Completed task
- [ ] Open task
  • Completed task
  • Open task

取り消し線

二重チルダでテキストに取り消し線を引きます。

~~strikethrough text~~
strikethrough text

言語指定付きのフェンスコードブロック

3つのバッククォート、任意の言語タグ(多くのレンダラーでシンタックスハイライトに使われます)、そしてコードの順に書きます。

```js
function greet(name) {
  return `Hello, ${name}!`;
}
```
function greet(name) {
  return `Hello, ${name}!`;
}

オートリンク

裸のURLは、括弧などを付けなくても自動的にクリック可能なリンクになります。

https://example.com

脚注(対応状況は様々)

脚注はキャレット記号と角括弧付きのラベルを使い、ドキュメントの後方で定義します:

Here's a claim.[^1]

[^1]: This is the footnote.

脚注はGitHub上ではレンダリングされますが、コアのCommonMarkにもテーブル/タスクリスト拡張にも含まれていません——このサイト自身の変換ツールも例外ではありません。実際に使うレンダラーで脚注構文を必ずテストしてから利用してください。

よくある質問

CommonMarkとGFMの違いは何ですか?

CommonMarkは、ほとんどのパーサーが実装している厳密で曖昧さのない仕様です。GitHub Flavored Markdown(GFM)はそのスーパーセットで、テーブル、タスクリスト、取り消し線、オートリンクをCommonMarkに追加します。このサイトのツールはCommonMarkに加え、これらのGFM拡張にも対応しています。

このチートシートを印刷したり、PDFとして保存したりできますか?

できます——ページ上部にある「印刷 / PDFとして保存」ボタンを使ってください。ブラウザ標準の印刷ダイアログが、余計な要素を省いたコンパクトなレイアウトで開きます。保存先として「PDFに保存」を選んでください。

このサイトのすべてのツールが、このページのすべての行に対応していますか?

基本構文の表はどこでも対応しています。拡張GFMセクション(テーブル、タスクリスト、取り消し線、オートリンク)は、すべての変換ツールとエディタのライブプレビューで対応しています。脚注だけが唯一の例外です——該当セクションの注記を参照してください。

この構文をその場で試すにはどうすればいいですか?

Markdownエディタを開いてください。入力しながらサニタイズ済みのライブプレビューがレンダリングされるので、実際のドキュメントで使う前に、ある構文がどのように表示されるかをすぐに確認できます。

Markdownのテーブルをドキュメントやスプレッドシートに変換するにはどうすればいいですか?

テーブルジェネレーターを使ってインタラクティブにテーブルを作成するか、既存のMarkdownをMarkdown to Word、Markdown to HTML、Markdown to PDFに貼り付けて別の形式で書き出してください。