マークダウン記法 使用例
改行
記述方法
改行の前に半角スペースを2つ記述。
記述例
あいうえお かきくけこ(スペース2つ) さしすせそ
結果
あいうえお
かきくけこ(スペース2つ)
さしすせそ
見出し
記述方法
1~6個まで#を記述。
数に応じて大きさが変わる。
記述例
# 見出し1 ## 見出し2 ### 見出し3
結果
見出し1
見出し2
見出し3
引用
記述方法
文頭に>を記述。
多重に記述するとネストされる形になる。
記述例
> 引用 >> 多重引用
結果
引用
多重引用
箇条書きリスト
記述方法
-, +, *のいずれかを記述。
タブ、もしくはスペースでネスト型になる。
記述例
- リスト1
- リスト1-1
- リスト1-1-1
- リスト1-1-2
- リスト1-2
- リスト2
結果
- リスト1
- リスト1-1
- リスト1-1-1
- リスト1-1-2
- リスト1-2
- リスト1-1
- リスト2
番号付きリスト
記述方法
番号.を記述。
ネスト型は箇条書き同様タブまたはスペースで表す。
番号は表示される際自動的に割り当てられるので全て同じ番号で良い。
記述例
1. 番号付きリスト1
1. 番号付きリスト1-1
1. 番号付きリスト1-2
1. 番号付きリスト2
1. 番号付きリスト3
結果
- 番号付きリスト1
- 番号付きリスト1-1
- 番号付きリスト1-2
- 番号付きリスト2
- 番号付きリスト3
code記法
文字列をバッククォートで囲む
記述例
`$ bundle install` を実行
結果
$ bundle install を実行
強調
記述方法
*, _のどちらかを記述。
1個…斜体
2個…太字
3個…斜体&太字
記述例
*第1位*です **第1位**です ***第1位***です
結果
第1位です
第1位です
第1位です
水平線
記述方法
*, _, -のいずれかを3つ以上連続して記述。
記述例
***
結果
取り消し線
記述方法
チルダ2つで囲む。
記述例
~~間違えた~~
結果
間違えた
リンク
記述方法
[表示文字](リンクurl)を記述。
記述例
[RUNTEQ](https://runteq.jp/)
結果
表（テーブル）
記述方法
構造は大きく分けて3つ。
ヘッダー行、アラインメント行、データ行。
表の列数はヘッダー行の列数で決まる。
アラインメント行では表の設定を行う。
- 左寄せ
---または:-- - 右寄せ
--: - 中央
:-:
-と:を合わせて最低3文字の記述が必要。
記述例
左寄せ aaaaaa |bbbbbb |cccccc ---|---|--- 1 |2 |3 中央 aaaaaa |bbbbbb |cccccc :-:|:-:|:-: 1 |2 |3 右寄せ aaaaaa |bbbbbb |cccccc --:|--:|--: 1 |2 |3
結果
左寄せ
| aaaaaa | bbbbbb | cccccc |
|---|---|---|
| 1 | 2 | 3 |
中央
| aaaaaa | bbbbbb | cccccc |
|---|---|---|
| 1 | 2 | 3 |
右寄せ
| aaaaaa | bbbbbb | cccccc |
|---|---|---|
| 1 | 2 | 3 |
