目次
Markdownとは
Markdownは、文章に少しだけ記号を加えることで、見出し、箇条書き、リンク、引用、表などを表現できる記法です。HTMLを直接書かなくても、読みやすい本文を作れます。
このサイトの記事本文もMarkdownで書けます。
見出し
見出しは # を使います。# の数が少ないほど大きな見出しになります。
## 大見出し
### 小見出し
記事本文では、主な区切りに ##、その中の小さな区切りに ### を使うと読みやすくなります。
段落と改行
段落は空行で区切ります。
これは1つ目の段落です。
これは2つ目の段落です。
文の途中で改行しても、表示上は同じ段落として扱われます。明確に段落を分けたいときは、空行を入れます。
強調
太字や斜体は * を使います。
**太字**
*斜体*
表示例:
太字
斜体
箇条書き
順序のないリストは - を使います。
- 1つ目の項目
- 2つ目の項目
- 3つ目の項目
表示例:
- 1つ目の項目
- 2つ目の項目
- 3つ目の項目
順序のあるリストは数字を使います。
1. 最初にすること
2. 次にすること
3. 最後にすること
表示例:
- 最初にすること
- 次にすること
- 最後にすること
リンク
リンクは [表示する文字](URL) の形で書きます。
[Hugo](https://gohugo.io/)
表示例:
画像
画像はリンクに ! を付けて書きます。
[] の中には、画像が表示されない場合や読み上げ環境で使われる説明文を書きます。
引用
引用は > を使います。
> これは引用文です。
> 複数行にすることもできます。
表示例:
これは引用文です。 複数行にすることもできます。
コード
文中の短いコードはバッククォートで囲みます。
`hugo server`
表示例:
hugo server
複数行のコードは、バッククォート3つで囲みます。
```bash
hugo server -D
```
表示例:
hugo server -D
表
表は | と - を使って書きます。
| 記法 | 用途 |
|---|---|
| `##` | 見出し |
| `-` | 箇条書き |
| `>` | 引用 |
表示例:
| 記法 | 用途 |
|---|---|
## | 見出し |
- | 箇条書き |
> | 引用 |
区切り線
区切り線は --- を単独の行に書きます。
---
表示例:
書き方の目安
Markdownは、凝った装飾をするための記法ではなく、文章の構造を分かりやすくするための記法です。まずは見出し、段落、箇条書き、引用、リンクを使えれば、読みやすい記事を作れます。