目的
Markdown記法のチートシートはあちらこちらに存在するが、あえてそれを自ら表現することにより理解を深め、及び身につけること並びに自らの表現が他者の理解に資する可能性があることを鑑み、情報を共有することを目的とする。
Markdown記法
見出し
- 文頭に、# 文 のように書くと、見出しになる。
- #の後に半角スペースを入れること。
- #の前に半角スペースを入れても構わない。
- #の数によってレベルを表す。
## レベル２の見出し
### レベル３の見出し
強調
- *文* のように文を囲むと、文がイタリック体で表示される。HTMLでいうところのemタグ。_でもよい。
ここを→イタリック体にする。 - **文** のように文を囲むと、文が太字になる。HTMLで言うところのstrongタグ。__でもよい。
ここを→太字にする。
打ち消し線
- ~~文~~ のように文を囲むと、文に打ち消し線を引くことができる。
ここを→打ち消す。
順序なしリスト
- 文頭に、- 文、* 文、+ 文 のように書くと、順序なしリストになる。
- 記号の後には半角スペースを入れること。
- 記号の前にタブ文字を入れると、レベルが一つ下がる。
順序ありリスト
- 文頭に、数字. のように書くと、順序ありリストになる。
- .の後には半角スペースを入れること。
- 数字はなんでも良い。
- 記号の前にタブ文字を入れると、レベルがひとつ下がる。この場合に、レベルの下がったリストは数字の1から始めなければ順序ありリストにならない。
引用
- 文頭に、>を置く。
- 複数行に渡る場合は、各行に>を置くこと。
- 引用の前後には空行を置くこと。
- >の数を増やすと、その行以降がネストした引用となる。
水平線
- ---又は***のように書くと、水平線となる。
リンク
- [表示テキスト](URL "タイトル") のように書くと、リンクとなる。
- "タイトル"は省略できる。
画像埋め込み
- リンクの書き方の前に!を置く。
コードブロック
- ``` を置いた行で囲んだところはコードブロックとなる。
- 始めの```において、```言語名:ファイル名 のように書くと、シンタックスハイライトが適用される。
例
print()
- 言語名の前に、diff_ を置くと、Diffを追加できる。行の先頭に
-、+を置くことでDiffを表現できる。
例
- print("Hello, Warld!")
+ print("Hello, World!")
コードスパン
- `コード`のように書くと、コードをインライン表示することができる。
- コードスパン内でn連続の`を使いたいときは、コードスパンの開始及び終了の`の数をn+1個に増やす。