Markdown 記法サンプル

個人開発

このブログで記事を書くときに使える、基本的な Markdown 記法とその表示結果をまとめた見本ページ。スタイルの確認用リファレンスとして使う。

見出し

# の数で見出しのレベルが決まる。#(H1)が最上位、######(H6)が最下位。記事本文では H2(##)以下を使う。

H1

H2

H3

H4

H5
H6

段落

段落は空行で区切る。日本語の文章でも英数字が混ざる場合は、Astro のように半角スペースで囲むと読みやすくなる。ここは表示の詰まり具合や行間を確認するためのサンプルテキストで、ある程度の長さがあると実際の記事に近い見え方になる。

続けてもう一段落。段落と段落のあいだの余白、フォントの大きさ、色のコントラストなど、読み物として気持ちよく読めるかをここで確かめる。

画像

記法

markdown
![代替テキスト](画像への絶対パスまたは相対パス)

表示

ブログのプレースホルダー画像

引用

引用は別の情報源から引いてきた内容を表す。必要に応じて出典を添える。

出典なしの引用

記法

markdown
> 完璧を目指すよりまず終わらせろ。
> **注意**: 引用の中でも _Markdown 記法_ は使える。

表示

完璧を目指すよりまず終わらせろ。 注意: 引用の中でも Markdown 記法 は使える。

出典ありの引用

記法

markdown
> メモリを共有して通信するな。通信によってメモリを共有せよ。<br>
> — <cite>Rob Pike[^1]</cite>

表示

メモリを共有して通信するな。通信によってメモリを共有せよ。
Rob Pike1

記法

markdown
| 斜体      | 太字     | コード |
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |

表示

斜体 太字 コード
italics bold code

コードブロック

記法

バッククォート3つ ``` で囲む。開始の3つの直後に言語名(htmljavascriptcssmarkdowntypescriptbash など)を書くと、その言語のシンタックスハイライトが効く。

markdown
```html
<!doctype html>
<html lang="ja">
  <head>
    <meta charset="utf-8" />
    <title>サンプル HTML ドキュメント</title>
  </head>
  <body>
    <p>テスト</p>
  </body>
</html>
```

表示

html
<!doctype html>
<html lang="ja">
  <head>
    <meta charset="utf-8" />
    <title>サンプル HTML ドキュメント</title>
  </head>
  <body>
    <p>テスト</p>
  </body>
</html>

リスト

番号付きリスト

記法

markdown
1. 1つ目の項目
2. 2つ目の項目
3. 3つ目の項目

表示

  1. 1つ目の項目
  2. 2つ目の項目
  3. 3つ目の項目

箇条書きリスト

記法

markdown
- 項目
- 別の項目
- さらに別の項目

表示

  • 項目
  • 別の項目
  • さらに別の項目

ネストしたリスト

記法

markdown
- 果物
  - りんご
  - みかん
  - バナナ
- 乳製品
  - 牛乳
  - チーズ

表示

  • 果物
    • りんご
    • みかん
    • バナナ
  • 乳製品
    • 牛乳
    • チーズ

その他の要素 — abbr, sub, sup, kbd, mark

記法

markdown
<abbr title="Graphics Interchange Format">GIF</abbr> はビットマップ画像形式のひとつ。

H<sub>2</sub>O

X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>

<kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Delete</kbd> を押してセッションを終了する。

<mark>ハイライト</mark>したいテキストを強調できる。

表示

GIF はビットマップ画像形式のひとつ。

H2O

Xn + Yn = Zn

Ctrl + Alt + Delete を押してセッションを終了する。

ハイライトしたいテキストを強調できる。

Footnotes

  1. 上記は 2015 年 11 月 18 日の Gopherfest における Rob Pike の講演からの引用。

ゆべしま
フロントエンドエンジニア。型と開発体験の話が好き。週末は個人開発とコーヒー。