Markdown記法のチートシートです。
本ページではQiitaで使用可能なMarkdownのみ掲載しているため、一部原文と異なります。
Markdownの原文については、Daring Fireball: Markdown Syntax Documentationをご覧下さい。
また、コードに関する記法はGitHub Flavored Markdownに準拠しています。
Qiitaでシンタックスハイライト可能な言語一覧については、 シンタックスハイライト可能な言語 をご覧下さい。
Code - コードの挿入
たとえば、Rubyで記述したコードをファイル名「qiita.rb」として投稿したいときは、 バッククオート を使用して以下のように投稿するとシンタックスハイライトが適用されます。
コードブロック上下に空行を挿入しないと正しく表示されないことがあります。
(空行)
```ruby:qiita.rb
puts 'The best way to log and share programmers knowledge.'
```
(空行)
結果
puts 'The best way to log and share programmers knowledge.'
現状では、ファイル名部分には半角スペースを直接使うことができません。
全角スペースか、  のようなHTML文字参照で代用できます。
```ruby:qiita motto.rb (2)
puts 'The best way to log and share programmers knowledge.'
```
結果
puts 'The best way to log and share programmers knowledge.'
また、コードをインライン表示することも可能です。
` puts 'Qiita'` はプログラマのための技術情報共有サービスです。
結果
puts 'Qiita' はプログラマのための技術情報共有サービスです。
インラインコードがn個連続するバッククオートを含む場合、n+1連続のバッククオートで囲みます。
`` `バッククオート` `` や ``` ``2連続バッククオート`` ``` も記述できます。
結果
`バッククオート` や ``2連続バッククオート`` も記述できます。
インラインコードの中身が CSS の <color> 型の RGB 16進数表記, rgb(), rgba(), hsl(), hsla() 場合横にその色が表示されます。
`#ffce44`
`rgb(255,0,0)`
`rgba(0,255,0,0.4)`
`hsl(100, 10%, 10%)`
`hsla(100, 24%, 40%, 0.5)`
結果
#ffce44
rgb(255,0,0)
rgba(0,255,0,0.4)
hsl(100, 10%, 10%)
hsla(100, 24%, 40%, 0.5)
Gist連携について → 2019年1月8日提供終了
Format Text - テキストの装飾
Headers - 見出し
- # これはH1タグです
- ## これはH2タグです
- ###### これはH6タグです
Emphasis - 強調・強勢
_ か * で囲むとHTMLのemタグになります。Qiitaでは*イタリック体*になります。
__ か ** で囲むとHTMLのstrongタグになります。Qiitaでは**太字**になります。
_ か * で囲むとHTMLのemタグになります。Qiitaではイタリック体になります。
__ か ** で囲むとHTMLのstrongタグになります。Qiitaでは太字になります。
Strikethrough - 打ち消し線
打ち消し線を使うには ~~ で囲みます。 ~~打ち消し~~
打ち消し線を使うには ~~ で囲みます。 打ち消し
イタリックや太文字と同様に前後に 半角スペース か 改行文字 が必要です。
Details - 折りたたみ
追加情報としたい内容を、detailsタグで囲みます。そして、要約として表示したい文章をsummaryタグで記載します。
Qiitaとは
<details><summary>Qiita(キータ)は、プログラマのための技術情報共有サービスです。</summary>プログラミングに関することをどんどん投稿して、知識を記録、共有しましょう。
Qiitaに投稿すると、自分のコードやノウハウを見やすい形で残すことができます。
技術情報はテキストファイルへのメモではなく、タグを付けた文章、シンタックスハイライトされたコードで保存することで初めて再利用可能な知識になる、そうQiitaでは考えています。</details>
追加情報としたい内容を、detailsタグで囲みます。そして、要約として表示したい文章をsummaryタグで記載します。
Qiitaとは
Qiita(キータ)は、プログラマのための技術情報共有サービスです。
プログラミングに関することをどんどん投稿して、知識を記録、共有しましょう。
Qiitaに投稿すると、自分のコードやノウハウを見やすい形で残すことができます。
技術情報はテキストファイルへのメモではなく、タグを付けた文章、シンタックスハイライトされたコードで保存することで初めて再利用可能な知識になる、そうQiitaでは考えています。
折りたたんだ部分で Markdown を使いたい場合は、折りたたまれる部分全体を <div> で囲ってください。（\` は実際は \ を含みません。また <div> とコードブロックの間には空白行が一つ以上必要です。）
<details><summary>サンプルコード</summary><div>
\```rb
puts 'Hello, World'
\```
</div></details>
サンプルコード
puts 'Hello, World'
Note - 補足説明
目を引く形で補足説明をしたい場合、補足したい内容を`:::note info`と `:::` で囲みます。
補足したい内容と`:::note info` と `:::` はそれぞれ別の行にする必要があります。
noteの後のinfoは省略可能です。
また、 noteの後にwarnをつけると警告メッセージに、alertをつけるとより強い警告メッセージとして表現することができます。
:::note info
インフォメーション
infoは省略可能です。
:::
:::note warn
警告
○○に注意してください。
:::
:::note alert
より強い警告
○○しないでください。
:::
目を引く形で補足説明をしたい場合、補足したい内容を:::note infoと ::: で囲みます。
補足したい内容と:::note info と ::: はそれぞれ別の行にする必要があります。
noteの後のinfoは省略可能です。
また、 noteの後にwarnをつけると警告メッセージとして、alertをつけるとより強い警告メッセージとして表現することができます。
インフォメーション infoは省略可能です。
警告 ○○に注意してください。
より強い警告 ○○しないでください。
Lists - リスト
Disc型
- 文頭に「*」「+」「-」のいずれかを入れるとDisc型リストになります
- 要点をまとめる際に便利です
- リストを挿入する際は、 リストの上下に空行がないと正しく表示されません。また「*」「+」「-」の後にはスペースが必要です
Decimal型
- 文頭に「数字.」を入れるとDecimal型リストになります
- 後からの挿入/移動を考慮して、1. 2. 3. と順番にするのではなく、1. 1. 1. という風に同じ数字にしておくといい具合です。
- リストを挿入する際は、 リストの上下に空行がないと正しく表示されません。また「数字.」の後にはスペースが必要です
Definition型
HTMLの<dl>タグをそのまま使うことで実現できます。
<dl>
<dt>リンゴ</dt>
<dd>赤いフルーツ</dd>
<dt>オレンジ</dt>
<dd>橙色のフルーツ</dd>
</dl>
次のようになります。
- リンゴ
- 赤いフルーツ
- オレンジ
- 橙色フルーツ
注意するべきは、Definition型のリスト内ではMarkdown記法が使えないということです。例えば以下のように書いてはなりません。
<dl>
<dt>リンゴ</dt>
<dd> とても **赤い** フルーツ </dd>
</dl>
次のようになってしまいます。
- リンゴ
- とても **赤い** フルーツ
Definition型リスト内ではMarkdown記法ではなくて、HTMLタグを使って修飾しなければならないので、正しくは次のようになります。
<dl>
<dt>リンゴ</dt>
<dd> とても<strong>赤い</strong>フルーツ </dd>
</dl>
- リンゴ
- とても赤いフルーツ
Markdown記法とHTMLタグの対応は次のようになっています。
| 修飾 | Markdown | HTML |
|---|---|---|
| ボールド | ** ** |
<strong></strong> |
| イタリック | _ _ |
<em></em> |
| コード | `` |
<code></code> |
| リンク | [text](url) |
<a href="url">text</a> |
Checkbox型
Disc型の記述の後ろに[ ]を入れるとチェックボックスが生成されます。
チェックが入った状態のボックスを生成する場合は[x]を入力します。
前後にスペースが必要です。
- [ ] タスク1
- [x] タスク2
- タスク1
- タスク2
Blockquotes - 引用
> 文頭に>を置くことで引用になります。
> 複数行にまたがる場合、改行のたびにこの記号を置く必要があります。
> 引用の上下にはリストと同じく空行がないと正しく表示されません
> 引用の中に別のMarkdownを使用することも可能です。これはネストされた引用です。
Horizontal rules - 水平線
下記は全て水平線として表示されます
* * *
***
*****
- - -
---------------------------------------
Links - リンク
- [リンクテキスト](URL "タイトル")
- タイトル付きのリンクを投稿できます。
(タイトルは、リンク上にマウスホバーすることで表示されます。)
- タイトル付きのリンクを投稿できます。
例
Markdown: [Qiita](http://qiita.com "Qiita Home")
結果: Qiita
- [リンクテキスト](URL)
- こちらはタイトル無しのリンクになります。
例
Markdown: [Qiita](http://qiita.com)
結果: Qiita
- [リンクテキスト][名前]
- [名前]:URL
- 同じURLへのリンクを複数箇所に設定することができます
例
Markdown:
[ここ][link-1] と [この][link-1] リンクは同じになります。
[link-1][] も可能です。
[link-1]:http://qiita.com/drafts/c686397e4a0f4f11683d
Images - 画像埋め込み
- 
- タイトル無しの画像を埋め込む
- 
- タイトル有りの画像を埋め込む
例
Markdown: 
結果:
テーブル記法
入力補完を利用する場合
手動で入力する場合
| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This | This | This |
| column | column | column |
| will | will | will |
| be | be | be |
| left | right | center |
| aligned | aligned | aligned |
上記のように書くと，以下のように表示されます．
| Left align | Right align | Center align |
|---|---|---|
| This | This | This |
| column | column | column |
| will | will | will |
| be | be | be |
| left | right | center |
| aligned | aligned | aligned |
数式の挿入
コードブロックの言語指定に "math" を指定することでTeX記法を用いて数式を記述することができます。
```math
\left( \sum_{k=1}^n a_k b_k \right)^{!!2} \leq
\left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
```
\left( \sum_{k=1}^n a_k b_k \right)^{\!\!2} \leq
\left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)
$2^3$ のように数式を "$" で挟むと行中に数式を埋め込むこともできます。
x^2 + y^2 = 1 をインライン表示すると $x^2 + y^2 = 1$ になります。
ただしインライン数式の中でコントロールシンボル（\{のような、バックスラッシュの後に記号が続くもの）を使うと、後述のバックスラッシュによるMarkdownのエスケープと衝突してしまいます。
$a = \{1, 2, 3\}$
$a = {1, 2, 3}$
なので次のように二つのバックスラッシュを使います。
$a = \\{1, 2, 3\\}$
$a = \{1, 2, 3\}$
目次(TOC)の自動挿入
目次は記事内の見出しを元に自動生成し、右上に自動挿入されます。詳細は目次機能の紹介記事をご覧ください。
注釈
本文中に[^1]や[^example]のように文字列を記述することで、脚注へのリンクを表現できます。注釈内容は、同じく本文中に [^1]: ... というように記述します1。
絵文字
厳密には Markdown 記法の外ですが、: で囲って、絵文字を埋め込めます。
例
\:kissing_closed_eyes: chu☆
chu☆
絵文字チートシート
http://www.emoji-cheat-sheet.com/
リンクカード
URLをリンクカードとして表示します。URLの前後に改行が必要です。
例
(空行)
https://qiita.com/Qiita/items/c686397e4a0f4f11683d
(空行)
結果
コンテンツの埋め込み
以下のサービスの埋め込みスクリプト/Embedタグが利用可能です。
<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">Qiita Advent Calendar 2020 開催のお知らせ🎅<br><br>おかげさまで今年で開催10周年となりました！<br>今年は例年以上に楽しんでいただけるようにお楽しみ企画を多数ご用意しています🎄<br>詳細はBlogよりご覧ください。<br><br>みなさんのご参加お待ちしています🚀<a href="https://t.co/zR5SdARdbB">https://t.co/zR5SdARdbB</a></p>— Qiita (キータ) 公式 (@Qiita) <a href="https://twitter.com/Qiita/status/1323176042425540614?ref_src=twsrc%5Etfw">November 2, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
Qiita Advent Calendar 2020 開催のお知らせ🎅
— Qiita (キータ) 公式 (@Qiita) November 2, 2020
おかげさまで今年で開催10周年となりました！
今年は例年以上に楽しんでいただけるようにお楽しみ企画を多数ご用意しています🎄
詳細はBlogよりご覧ください。
みなさんのご参加お待ちしています🚀https://t.co/zR5SdARdbB
URL入力でもウィジェット表示できるようになりました。
(空行)
https://twitter.com/Qiita/status/1365218441011990531
(空行)
Asciinema
<script id="asciicast-7592" src="https://asciinema.org/a/7592.js" async></script>
CodePen
<p data-height="265" data-theme-id="0" data-slug-hash="dJgNLK" data-default-tab="js,result" data-user="tomoasleep" data-embed-version="2" data-pen-title="dJgNLK" class="codepen">See the Pen <a href="https://codepen.io/tomoasleep/pen/dJgNLK/">dJgNLK</a> by Tomoya Chiba (<a href="https://codepen.io/tomoasleep">@tomoasleep</a>) on <a href="https://codepen.io">CodePen</a>.</p>
<script async src="https://production-assets.codepen.io/assets/embed/ei.js"></script>
See the Pen dJgNLK by Tomoya Chiba (@tomoasleep) on CodePen.
YouTube
<iframe width="560" height="315" src="https://www.youtube.com/embed/M7lc1UVf-VE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
SlideShare
<iframe src="//www.slideshare.net/slideshow/embed_code/key/B6SfqHFrWhihpr" width="595" height="485" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
Google Slide
<iframe src="https://docs.google.com/presentation/d/e/2PACX-1vQGCGO4BKNKmsm3Oml53J5vTzK7dRBqXHoABnftOb5n3HLiixWzNCMmwc2w7InQig/embed?start=false&loop=false&delayms=3000" frameborder="0" width="500" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
Speaker Deck
<script async class="speakerdeck-embed" data-id="f41af42d719b40529cdd96e393c410e6" data-ratio="1.77777777777778" src="//speakerdeck.com/assets/embed.js"></script>
その他
バックスラッシュ[\]をMarkdownの前に挿入することで、Markdownをエスケープ(無効化)することができます。
例
# H1
エスケープされています
また本文では一部のHTMLタグも利用可能です。
QiitaのMarkdown記法の改善について
QiitaのMarkdown記法は
でOSSとして公開されています。
埋め込みコンテンツの追加や記法の追加などご要望があれば、このリポジトリにIssueやPRをいただければ検討することができます。
-
注釈内容を記述する位置は、本文の途中でも末尾でも構いません。 ↩