マークダウン(Markdown : MD)ファイルは HTML ファイルのように文章の構造を記述するためのマークアップ言語の一つです。
テキストファイル形式で、かつタグを使わずに簡単に Web ページを作ることが出来ます。
さて GitHub Pages でも MD ファイルを使うことが可能です。
ここでは MD ファイルの文法について学びます。
なおホスティングサービスによってマークダウンの文法に結構違いがありますので注意して下さい。
普通のテキスト文章を打てば良いだけですが、文章の前後に半角スペースを入れないで下さい(意図しない表示になる時があります)。
(例) こんにちは世界
強制的に改行したい時は段落の後ろに半角スペースを2つ入れるか空行を段落の間に入れます。
ただし空行を入れた場合は段落間が1行空きます。
(改行されない例) こんにちは 世界 (改行される例その1) こんにちは (←半角スペースx2を後ろに追加) 世界 (改行される例その2) こんにちは 世界
太字にしたい場合は段落の前後を ** で囲みます。
(例) **こんにちは世界**
箇条書きは段落の前に - を付けます。
なお - と文章の間には半角スペースを1つ入れて下さい。
またレベルを下げる時はレベルx2個分の半角スペースを先頭に入れてください。
(例) - レベル 0 - レベル 0 - レベル 1 (半角スペース 1x2 = 2 個) - レベル 1 - レベル 2 (半角スペース 2x2 = 4 個) - レベル 2 - レベル 1 - レベル 0
番号付きの箇条書きの場合は段落の前に 1. を付けます。
なお 1. と文章の間には半角スペースを1つ入れて下さい。
またレベルを下げる時はレベルx3個分の半角スペースを先頭に入れてください。
(例) 1. レベル 0 1. レベル 0 1. レベル 1 (半角スペース 1x3 = 3 個) 1. レベル 1 1. レベル 2 (半角スペース 2x3 = 6 個) 1. レベル 2 1. レベル 1 1. レベル 0
# を段落の前に入れます。
なお # と文章の間には半角スペースを1つ入れて下さい。
また # の数を増やすとレベルが下がります
(例) # レベル0 ほげ ## レベル1 ふが ### レベル2 ぴよ
リンクは文章内に
[文字](アドレス)
を入れると貼ることが出来ます。
(例) ほげ[ふが](https://github.com/)ぴよ
なおサブページにリンクを貼りたい場合はアドレスを相対アドレスにします。
(例) docs/index.md から docs/fuga/hoge.md にリンクを貼る場合 [ほげ](./fuga/hoge.md)
画像は画像ファイルを用意してから文章内に
![文字](相対アドレス)
を入れると貼ることが出来ます。
なお[文字]の部分は実際には Web ページ上に表示されません。
(例) docs/index.md で docs/hoge.png の画像を表示したい場合 ![ほげ](./hoge.png)
他にも様々な文法がありますので、必要に応じて自分で調べて下さい。