MDUtil

Markdownチートシート

Markdownの記法を1ページにまとめ、入力する書き方と表示結果を並べました。各行から詳しいガイドに移動でき、数枚に印刷して手元に置いておけます。

基本の記法

記法Markdown表示結果
見出し
# 見出し1
## 見出し2
### 見出し3
見出し1
見出し2
見出し3
太字
**太字**

太字

斜体
*斜体*

斜体

引用
> 引用文

引用文

箇条書き
- 1つ目の項目
- 2つ目の項目
  • 1つ目の項目
  • 2つ目の項目
番号付きリスト
1. 1つ目の項目
2. 2つ目の項目
  1. 1つ目の項目
  2. 2つ目の項目
インラインコード
`npm install` を実行

npm install を実行

コードブロック
```js
console.log("hi");
```
console.log("hi");
リンク
[サンプルサイト](https://example.com)
画像
![ドキュメントの状態](/samples/badge.svg)

ドキュメントの状態

水平線
---

改行
1行目\
2行目

1行目
2行目

エスケープ
\*斜体ではない\*

*斜体ではない*

拡張記法

記法Markdown表示結果
表
| 名前 | 担当 |
| --- | --- |
| 田中 | デザイン |
名前担当
田中デザイン
タスクリスト
- [x] 完了
- [ ] 未完了
  • 完了
  • 未完了
取り消し線
~~取り消し線~~

取り消し線

脚注
ある主張。[^1]

[^1]: 出典。

ある主張。1

Footnotes
  1. 出典。 ↩

ハイライト
<mark>ハイライト</mark>

ハイライト

数式
$E = mc^2$

E=mc2E = mc^2

HTMLを使う書式

記法Markdown表示結果
下線
<ins>下線</ins>

下線

コメント
<!-- 非表示のメモ -->

何も表示されません

文字色
$\color{#d1242f}{\text{赤い文字}}$

赤い文字\color{#d1242f}{\text{赤い文字}}

中央寄せ
<p align="center">中央の文字</p>

中央の文字

折りたたみ
<details>
<summary>クリックして開く</summary>

折りたたんだ内容

</details>
クリックして開く

折りたたんだ内容

上付き・下付き
x<sup>2</sup> と H<sub>2</sub>O

x2 と H2O

よくある質問

Markdownとは何ですか?

見出しに #、太字に ** のような記号を使って、テキストに書式を付ける書き方です。テキストのままでも読みやすく、アプリが整ったページ、文書、メッセージとして表示します。

基本の記法と拡張記法の違いは?

基本の記法はどのMarkdownアプリでも使える中心部分で、現在はCommonMarkとして仕様化されています。拡張記法は表、タスクリスト、取り消し線、脚注などを加えたもので、多くはGitHub Flavored Markdown由来です。多くのアプリが対応していますが、すべてではありません。

GitHubのMarkdownは同じですか?

GitHubはGitHub Flavored Markdownを使い、基本の記法すべてに加えて、表、タスクリスト、取り消し線、脚注、自動リンク、アラート、数式に対応しています。このチートシートの最初の2つのグループはすべてGitHubで使えます。

Markdownの中でHTMLを使えますか?

多くのレンダラーはインラインHTMLに対応しており、下線、中央寄せ、折りたたみはHTMLで書きます。サイトは安全のためにHTMLを整理します。たとえばGitHubは <ins>、<sup>、align を残し、style を取り除きます。

Markdownファイルの拡張子は?

もっとも一般的なのは .md で、.markdown も使えます。どちらもテキストファイルなので、どのエディタでも開けます。

このチートシートを印刷したりPDFで保存したりするには?

表の上の「印刷」ボタンかブラウザの印刷を使い、PDFにする場合はプリンターで「PDFに保存」を選びます。印刷ではヘッダー、フッター、よくある質問は省かれます。

ほかのサイトでMarkdownの見た目が変わるのはなぜですか?

アプリごとに対応する拡張記法とHTMLの扱いが異なるためです。このサイトの各ガイドには、GitHub、Discord、Slack、Obsidianなどでの扱いをまとめています。

Markdownを試せる場所はありますか?

Markdown プレビューを開き、左側に入力すると右側に結果が表示されます。