1. マークダウンの基本文法
1. タイトルの構文
タイトルを作成するには、単語またはフレーズの前にシャープ記号 (#) を付けます。# の数字はタイトルのレベルを表します。たとえば、# を 3 つ追加すると、第 3 レベルの見出し (<h3>) が作成されます (例: ### My Header)。
| マークダウン構文 | HTML | プレビュー効果 |
|---|---|---|
| # 見出しレベル 1 | <h1>見出しレベル 1</h1> | 見出しレベル 1 |
| ## 見出しレベル 2 | <h2>見出しレベル 2</h2> | 見出しレベル 2 |
| ### 見出しレベル 3 | <h3>見出しレベル 3</h3> | 見出しレベル 3 |
| #### 見出しレベル 4 | <h4>見出しレベル 4</h4> | 見出しレベル 4 |
| ##### 見出しレベル 5 | <h5>見出しレベル 5</h5> | 見出しレベル 5 |
| ###### 見出しレベル 6 | <h6>見出しレベル 6</h6> | 見出しレベル 6 |
1.1 オプションの構文
また、テキストの下に任意の数の == 記号を追加して第 1 レベルの見出しを識別したり、- 記号を追加して第 2 レベルの見出しを識別したりすることもできます。
| マークダウン構文 | HTML | プレビュー効果 |
|---|---|---|
| 見出しレベル 1 ============ |
<h1>見出しレベル 1</h1> | 見出しレベル 1 |
| 見出しレベル 2 ------------------------ |
<h2>見出しレベル 2</h2> | 見出しレベル 2 |
1.2 ベストプラクティス
異なる Markdown アプリケーションでは、# と見出しの間のスペースの処理に一貫性がありません。互換性を確保するために、# とタイトルをスペースで区切ってください。
| ✅これをしてください | ❌ こんなことはしないでください |
|---|---|
| # ここに見出しがあります | #ここに見出しがあります |
2. 段落文法
2.1 ベストプラクティス
3. 改行構文
3.1 ベストプラクティス
4. 文法を重視する
テキストを太字または斜体にして、テキストの重要性を強調します。
4.1 太字
テキストを太字にするには、単語または語句の前後に 2 つのアスタリスク (アスタリスク) またはアンダースコア (アンダースコア) を追加します。強調するために単語または語句の中央を太字にするには、太字部分の両側に 2 つのアスタリスク (アスタリスク) を追加します。
| マークダウン構文 | HTML | プレビュー効果 |
|---|---|---|
| 私は**太字**が大好きです。 | 私はとにかく<strong>太字</strong>が大好きです。 | 私は太字のテキストが大好きです。 |
| 私は_太字_が大好きです。 | 私はとにかく<strong>太字</strong>が大好きです。 | 私は太字のテキストが大好きです。 |
| 愛**は大胆です | 愛は<strong></strong>大胆です | 愛は大胆だ |
4.1.1 ベストプラクティス
Markdown アプリケーションでは、単語やフレーズの途中にあるアンダースコアの処理方法が一貫していません。互換性を保つため、単語または語句の中央を太字にする場合はアスタリスクを使用してください。
| ✅これをしてください | ❌ こんなことはしないでください |
|---|---|
| 愛**は大胆です | 愛は大胆だ |
4.2 斜体
テキストを斜体にするには、単語または語句の前後にアスタリスク (アスタリスク) またはアンダースコア (アンダースコア) を追加します。単語の中央を斜体にするには、文字の前後にスペースを入れずにアスタリスクを追加します。
4.2.1 ベストプラクティス
テキストを太字と斜体の両方で強調表示するには、単語または語句の前後に 3 つのアスタリスクまたは下線を追加します。単語またはフレーズの中央を太字または斜体にするには、強調表示する部分の前後にスペースを入れずに 3 つのアスタリスクを追加します。
| ✅これをしてください | ❌ こんなことはしないでください |
|---|---|
| あ*猫*ニャー | A_猫ニャー |
4.3 太字と斜体
テキストを太字と斜体の両方で強調表示するには、単語または語句の前後に 3 つのアスタリスクまたは下線を追加します。単語またはフレーズの中央を太字または斜体にするには、強調表示する部分の前後にスペースを入れずに 3 つのアスタリスクを追加します。
4.3.1 ベストプラクティス
| ✅これをしてください | ❌ こんなことはしないでください |
|---|---|
| This is really***very***important text. | This is really___very___important text. |
5、引用语法
要创建块引用，请在段落前添加一个 > 符号。
> Dorothy followed her through many of the beautiful rooms in her castle.
渲染效果如下所示：
Dorothy followed her through many of the beautiful rooms in her castle.
5.1 多个段落的块引用
块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
渲染效果如下：
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
5.2 嵌套块引用
块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。
> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
渲染效果如下：
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
5.3 带有其它元素的块引用
块引用可以包含其他 Markdown 格式的元素。并非所有元素都可以使用，你需要进行实验以查看哪些元素有效。
> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> *Everything* is going according to **plan**.
渲染效果如下：
The quarterly results look great!
- Revenue was off the chart.
- Profits were higher than ever.
Everything is going according to plan.
6、列表语法
可以将多个条目组织成有序或无序列表。
6.1有序列表
要创建有序列表，请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列，但是列表应当以数字 1 起始。
6.1.1 有序列表最佳实践
CommonMark および他のいくつかの軽量マークアップ言語では、括弧 ()) を区切り文字として使用できます (例: 1) 最初の項目) が、すべての Markdown アプリケーションがこれをサポートしているわけではないため、互換性の観点からは優れたオプションではありません。互換性を保つため、ピリオドのみを使用してください。
| ✅これをしてください | ❌ こんなことはしないでください |
|---|---|
| 1. 最初の項目 2. 2 番目の項目 |
1) 最初の項目 2) 2 番目の項目 |
6.2 順序なしリスト
順序なしリストを作成するには、各リスト項目の前にダッシュ (-)、アスタリスク (*)、またはプラス記号 (+) を付けます。1 つ以上のリスト項目をインデントすると、ネストされたリストが作成されます。
Markdown公式チュートリアル： https: //markdown.com.cn/