マークダウン記法とは
テキストをシンプルかつ読みやすい形式で記述できる軽量マークアップ言語の一つ
テキストエディタで簡単に記述できる
特徴
- 読みやすく、書きやすい
- シンプルで汎用性が高く、多くのツールやプラットフォームでサポートされている
- .mdの拡張子でファイル保存できる
用途
- ウェブ記事（Qiitaやnoteなど）
- ブログ（WordPress）
- ノートアプリ（NotionやObsidianなど）
- READMEファイル（GitHubやGitLabなど）
見出し
#の数が多いほど小さくなる
# 見出しレベル1
## 見出しレベル2
### 見出しレベル3
#### 見出しレベル4
##### 見出しレベル5
###### 見出しレベル6
リスト
箇条書きリスト
-のあとにスペース
-の前にスペース2個以上を記述すると入れ子になる
- 項目1
- 項目1-2
- 項目2
- 項目2-1
- 項目2-2
例
- 項目1
- 項目1-2
- 項目2
- 項目2-1
- 項目2-2
番号付きリスト
1.のあとにスペース
1.の前にスペース3個以上を記述すると入れ子になる
1. 項目1
1. 項目1-2
2. 項目2
1. 2-1
2. 2-2
例
- 項目1
- 項目1-2
- 項目2
- 2-1
- 2-2
強調
太字
**太字になります**
例
太字になります
斜体
*斜体になります*
例
斜体になります
コード
インラインコード
`$markdown`
例
$markdown
コードブロック
頭の```の後に言語を指定すると、文字に色が付き見やすくなる
``` php
if (!$isMarkdown) {
return false
}
```
例
if (!$isMarkdown) {
return false
}
引用
> これは引用です。
> これも引用です。
例
これは引用です。
これも引用です。
水平線
---
例
テーブル
| ヘッダー1 | ヘッダー2 | ヘッダー3 |
| --------- | --------- | --------- |
| 内容1 | 内容2 | 内容3 |
| 内容a | 内容b | 内容c |
例
| ヘッダー1 | ヘッダー2 | ヘッダー3 |
|---|---|---|
| 内容1 | 内容2 | 内容3 |
| 内容a | 内容b | 内容c |
リンク
[リンクテキスト](URL)
例
画像
例
チェックリスト
- [x] 完了タスク
- [ ] 未完了タスク
例
- 完了タスク
- 未完了タスク
展開
<details>
<summary>クリック</summary>
ここの内容が展開される
</details>
例
展開
ここの内容が展開されるnote, message
記述は各サービスによって異なります
Qiita
補足
:::note info
マークダウンはHTMLタグも使用できます。
:::
例
マークダウンはHTMLタグも使用できます。
注意
:::note warning
下記は必ずお読みください
:::
例
下記は必ずお読みください
警告
:::note alert
下記の内容は悪用しないでください
:::
例
下記の内容は悪用しないでください
GitHub
補足
> [!NOTE]
> マークダウンはHTMLタグも使用できます。
注意
> [!WARNING]
> 下記は必ずお読みください
警告
> [!WARNING]
> 下記の内容は悪用しないでください