Markdownの書き方

Markdown は、見出し・箇条書き・リンク・コード・表などを、 プレーンテキストで簡単に書ける軽量マークアップ言語です。

このページでは、**Markdown の書き方そのもの**を、 .rst 形式で説明します。

見出し

# の数で見出しレベルを表します。

書き方の例:

# 見出し1
## 見出し2
### 見出し3
#### 見出し4

段落と改行

普通に文章を書けば段落になります。

段落を分けるには、空行を1行入れます。

書き方の例:

1つ目の段落です。

2つ目の段落です。

行末で改行したい場合は、行末に半角スペースを2つ入れます。

書き方の例:

この行で改行したいです。
次の行です。

強調

イタリック、太字、打ち消し線が使えます。

書き方の例:

*italic*
_italic_

**bold**
__bold__

***bold italic***

~~取り消し~~

箇条書き

記号付きリスト

書き方の例:

- item 1
- item 2
- item 3

または:

* item 1
* item 2

番号付きリスト

書き方の例:

1. first
2. second
3. third

入れ子

書き方の例:

- parent
  - child
  - child
- parent 2

チェックリスト

環境によってはチェックリストも使えます。

書き方の例:

- [x] 完了
- [ ] 未完了

引用

書き方の例:

> これは引用です。
> 複数行も書けます。

入れ子の引用:

> 親引用
>> 子引用

インラインコード

文章中でコードやファイル名を示すときは、バッククォート `` ` `` を使います。

書き方の例:

これは `print("Hello")` の例です。
ファイル名は `sample.py` です。

コードブロック

コード全体を示すには、バッククォート3つ、またはチルダ3つ以上で囲みます。

書き方の例 1:

（バッククォートを3つ並べる）
python
def hello():
    print("Hello")
（バッククォートを3つ並べる）

言語名を付けると、対応環境ではシンタックスハイライトされます。

書き方の例 2:

（チルダを3つ並べる）python
def hello():
    print("Hello")
（チルダを3つ並べる）

リンク

通常リンク:

[Python](https://www.python.org/)

URL をそのまま書くこともできます:

https://www.python.org/

画像

書き方の例:

![サンプル画像](sample.png)

タイトル付き:

![サンプル画像](sample.png "タイトル")

水平線

書き方の例:

---

または:

***

表

書き方の例:

| 列1 | 列2 | 列3 |
|---|---|---|
| A | B | C |
| 1 | 2 | 3 |

寄せ方向の指定もできます。

書き方の例:

| 左寄せ | 中央寄せ | 右寄せ |
|:---|:---:|---:|
| a | b | c |
| 1 | 2 | 3 |

エスケープ

Markdown の記号をそのまま表示したい場合は、バックスラッシュ \ を前につけます。

書き方の例:

\*これはそのままアスタリスク表示です\*

数式

環境によっては LaTeX 形式の数式が使えます。

インライン数式:

$E = mc^2$

別行数式:

$$
E = mc^2
$$

raw HTML

Markdown 内では、対応している環境なら HTML タグをそのまま書けます。

基本例:

<b>太字</b>
<i>斜体</i>
<u>下線</u>

改行:

1行目<br>
2行目

色やサイズの指定（環境依存）:

<span style="color:red;">赤字</span>
<span style="font-size:150%;">大きな文字</span>

折りたたみ表示（対応環境のみ）:

<details>
<summary>クリックして展開</summary>

中身の文章です。

</details>

HTML の表:

<table>
  <tr><th>項目</th><th>値</th></tr>
  <tr><td>A</td><td>10</td></tr>
  <tr><td>B</td><td>20</td></tr>
</table>

注意:

  • Markdown エンジンによって使えるタグが異なる

  • script など危険なタグは通常禁止される

  • style 属性などが削除されることがある

  • GitHub, Pandoc, Jupyter, Sphinx 系で挙動が異なる

よく使う実用例

README 風の例です。

書き方の例:

# My Project

これはサンプルプロジェクトです。

## Features

- feature 1
- feature 2
- feature 3

## Installation

（バッククォートを3つ並べる）
bash
pip install myproject
（バッククォートを3つ並べる）

## Usage

（バッククォートを3つ並べる）
python
import myproject
myproject.run()
（バッククォートを3つ並べる）

## License

MIT

最小テンプレート

書き方の例:

# タイトル

概要を書く。

## セクション1

本文を書く。

- 項目1
- 項目2

## セクション2

`inline code` の例。

（バッククォートを3つ並べる）
python
print("Hello, Markdown")
（バッククォートを3つ並べる）

[リンク](https://example.com)

よくある注意点

  • 箇条書きの前後は空けると見やすい

  • 表は環境によって少し表示差がある

  • 改行は「空行」または「行末スペース2つ」で行う

  • コードブロック内では Markdown は通常解釈されない

  • Markdown 方言により機能差がある

  • raw HTML は便利だが、環境差が Markdown より大きい

最低限これだけ覚えれば十分

  • # 見出し

  • - 箇条書き

  • **太字**

  • `` code ``

  • バッククォート3つまたはチルダ3つ以上でコードブロック

  • [文字](URL) でリンク

  • ![alt](img.png) で画像

  • | ... | で表

  • 必要なら raw HTML も併用できる