🙄

Markdown記法とは

に公開

はじめに

本記事は、筆者の考えるMarkdown記法を使用して文章を書くために必要な最低限の知識と、よく使う構文をまとめたものです。

Markdown記法とは

Markdown記法とは、構造化された文章を書くためのプレーンテキストのフォーマットです。
構文に従って記述された文章は、Markdownに対応したツールで見やすく表示されます。

Markdown記法を使うメリット

筆者の考えるMarkdown記法のメリットは以下の3つです。

プレーンテキストのフォーマットであること

プレーンテキストは、文字だけのデータのことで、フォントや色などの書式情報を含みません。
プレーンテキストには、以下のようなメリットがあります。

  • 表示や編集の環境(ハードウェアやOS)を選ばない
  • 内容の比較やバージョン管理が容易
  • アプリケーションでデータが利用しやすい

シンプルで覚えやすく読みやすいこと

構文は全て網羅したとしても10種類程度です。
HTMLやXMLなどのマークアップ言語に比べて、プレーンテキストとして読みやすいです。

たくさんのサービスで採用されていること

GitHubやNotion、Zennなどの様々なサービスで採用されています。

見出し

サンプル

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

リスト

サンプル

- 項目
- 項目
- 項目
1. 項目1
2. 項目2
3. 項目3

表示

  • 項目
  • 項目
  • 項目
  1. 項目1
  2. 項目2
  3. 項目3

テーブル

サンプル

| Head | Head | Head |
| ---- | ---- | ---- |
| Data | Data | Data |
| Data | Data | Data |
| Data | Data | Data |

表示

Head Head Head
Data Data Data
Data Data Data
Data Data Data

リンク

構文

[リンクラベル](URL)

サンプル

[Zenn](https://zenn.dev/)

表示
Zenn

コードブロック

構文

```言語:ファイル名
内容
```

サンプル

```js:greet.js
const greet = () => {
  console.log("Hello")
}
```

表示

greet.js
const greet = () => {
  console.log("Hello")
}

画像

構文

![代替テキスト](URL)

強調

構文

**強調したい文字**

サンプル

メロスは**激怒**した。

表示
メロスは激怒した。

引用

サンプル

> 引用文

表示

引用文

Discussion