Markdown記法
Markdown記法は、
「HTMLタグ書くのめんどい。もっと簡単な記法で書く。書いたあとでツールでHTMLにする!」
という雑な要望を満たすために作られた記法。
見出し
見出しは#記号に半角スペースを開けて書く。
ただ文字が大きくなる、という効果だけでなく、これを元にツールが自動的に目次にする場合もあるで大事。
(このページの右側の目次は自動生成されたもの)
1 2 3 4 5 |
|
改行
半角スペースを二個行末に書くと改行する。
画像表示
以下の方法で表示できる。ただ、パスが微妙。
.mdファイルのある場所からの相対パス。(HTML生成後の実際のURLではないので注意)
1 |
|
画像の拡大縮小
Markdown記法では画像の表示は出来ても画像の拡大、縮小表示は出来ない。
諦めるか、HTMLでwidthとか使って書く。
なお、先ほど記載したようにパスが異なるので注意。
上記だとimg/lenna.pngだったのに、こっちだと../img/lenna.pngになったりするので。
1 |
|
URLのリンク付
[表示文字](リンクURL)
形式でリンク。
[Google](https://www.google.co.jp/)
Google
太字
アンダースコアを2つ__
で挟むと太字になる。
__こんな感じ__
で、こんな感じ。
水平線
アスタリスク3回並べると水平線。
***
アンダースコアを3回並べても水平線。
___
コードブロック
```で囲むことにより、コードブロック出来る。
`はShiftキー+@
1 2 3 4 5 |
|
文章内コードブロックは`一個で挟む。
`hoge`
hoge
箇条書きリスト
リスト表示
1 2 3 |
|
- AAAAA
- BBBBB
- CCCCC
深いリストは以下のように先頭にスペースをつける
1 2 3 4 5 |
|
- AAAAA
- aaaaa
- BBBBB
- CCCCC
- ccccc
数字のリストにしたい場合は-の代わりに数字+.(ドット)で数字リストになる。
1 2 3 |
|
- AAAAA
- BBBBB
- CCCCC
1 2 3 4 5 |
|
- AAAAA
- aaaaa
- BBBBB
- CCCCC
- ccccc
??? なんか数字のネストが変。まぁいいや。
テーブル(表)
1 2 3 4 |
|
で以下のようなテーブルになる。
aaa | bbb | ccc |
---|---|---|
111 | 222 | 333 |
444 | 555 | 666 |
途中の |---| が大事。
打ち消し線(取り消し線)
本来は~~で囲むと打消し線がでるらしいのですが、実際に ~~打消し線~~ とやっても全然打ち消されません。
MkDocs固有の問題かもしれません。
とりあえずですが、<strike>
タグで囲むと打ち消されるので、当面こちらで代用します。
1 2 3 4 5 |
|
aaa
bbb
ccc
以上。