Markdown 記法の基本
文字修飾
太字 ( Bold )
「**太字**
」で記述する。
**
の代わりに __
も使用可能。
**太字**
斜体 ( Italic )
「*斜体*
」で記述する。
*
の代わりに _
も使用可能。
*斜体*
取り消し線 ( Strikethrough )
「~~取り消し線~~
」で記述する。
~~取り消し線~~
改行
「<br>
」で記述する。
<br>
の代わりに「
(半角スペース ×2) + 改行 」も使用可能だが、編集時に扱いづらいので個人的には推奨しない。
文字列<br>この文字列は改行して表示される
文字列
この文字列は改行して表示されない
文字列<br>
この文字列は改行して表示される
引用
引用を解除する場合は、引用した行の次の行を 1 行空ける。
引用
「> 文字列
」で記述する。
>
の後ろは半角スペースを入れること。
> この文字列は引用表示される
> この文字列は引用表示される<br>
この文字列も引用表示される
> この文字列は引用表示される
この文字列は引用表示されない
多重引用
「>> 文字列
」で記述する。
>>
の後ろは半角スペースを入れること。
>> この文字列は多重引用表示される
> この文字列は引用表示される
>> この文字列は多重引用表示される<br>
> この文字列も多重引用表示される
>
> この文字列は引用表示される
見出し ( Heading, Index )
「# 文字列
」で記述する。
#
の後ろは半角スペースを入れること。
#
は 6 個まで。
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
リスト ( List )
小リストを内包する場合は、小リストのインデントを 1 つ下げる。
箇条書きリスト
「* 文字列
」で記述する。
*
の後ろは半角スペースを入れること。
*
の代わりに -
と +
も使用可能。
* リスト1
* リスト1-1
* リスト1-1-1
* リスト1-2
* リスト2
* リスト3
番号付きリスト
「半角数字. 文字列
」で記述する。
.
の後ろは半角スペースを入れること。
適切な番号に変換してくれるため半角数字はどの数字でも良いが、一般的には 1 を使用することが多い。
1. リスト1
1. リスト1-1
1. リスト1-1-1
1. リスト1-2
1. リスト2
1. リスト3
コード ( Code )
インラインコード ( InlineCode )
「`文字列`
」で記述する。
`コード`
コードブロック ( CodeBlock )
コードブロック
「```
+ 改行 + 文字列 + 改行 + ```
」で記述する。
```
の代わりに ~~~
も使用可能。
```
コード
```
シンタックスハイライト付きコードブロック
「```言語名
+ 改行 + 文字列 + 改行 + ```
」で記述する。
```
の代わりに ~~~
も使用可能。
```言語名
コード
```
リンク ( Link )
リンク
「[文字列](URL)
」で記述する。
[Google](https://www.google.co.jp)
タイトル付きリンク
「[文字列](URL "マウスホバー用文字列")
」で記述する。
URL の後ろは半角スペースを入れること。
文字列上にマウスホバーした際、マウスホバー用文字列が表示される。
[Google](https://www.google.co.jp "Google TopPage")
定義参照リンク
「[文字列]: URL
」で記述する。
:
の後ろは半角スペースを入れること。
この定義は使用箇所の前後どちらに記述しても良い。
[この文字列からも][Google]<br>
[こっちの文字列からも][Google]<br>
[Google] ←ここからも定義したリンク先へ飛ぶことができる
[Google]: https://www.google.co.jp
表 ( Table )
※ TODO("Not yet implemented")
画像埋め込み ( Image )
※ TODO("Not yet implemented")
コメント ( Comment )
「<!--文字列-->
」で記述する。
コメントは Markdown の出力には表示されない。
<!--コメント-->
水平線 ( Line, HorizontalRule )
「---
」で記述する。
---
の代わりに ***
と ___
も使用可能。
---
おまけ
たまに読み方を忘れる記号たち
-
~
:チルダ -
>
:大なり -
-
:ハイフン -
!
:エクスクラメーション -
`
:バッククォート
Discussion