README.md

GitHubでは、README.mdを以下の場所に置いておくと、GitHubのレポジトリトップにアクセスしたときに自動的に表示してくれます。

Visual Studio Code

VSCodeでREADME.mdを編集する場合、プレビューで確認することができます。プレビューを表示する操作は以下のようになります。

操作	Mac OSX	Windows・Linux
画面右半分にプレビューを表示	Command + K のあとに V	Ctrl + K のあとに V
別タブにプレビューを表示	Command + Shift + V	Ctrl + Shift + V

README.mdで使用するMarkdownについて

HTMLのH1～H6相当は、行頭の"#" ～ "######"となります。 H1は "#" が1個で、H6は "#" が6個になります。

例

# H1の表示
## H2の表示
### H3の表示
#### H4の表示
##### H5の表示
###### H6の表示

段落を入れたい場合は、空行を入れます。改行は、行末に半角スペース2個を入れます。

例半角スペースを■で表現した場合

1段落

2段落

1行目のあと改行(行末に2個スペース)■■  
2行目のあと改行なし
3行目のあと改行(行末に2個スペース)■■
4行目のあと改行なし

コードやコマンドなど、等幅フォントで表示する方法について。インラインコードは、バッククォートで囲みます。ただし、複数行を囲むと改行が無視されます。複数行のコードの場合は、行頭に半角スペース4個を入れます。

例　半角スペースを■で表現した場合

これは、`$title = "インラインコードの例"` です。

■■■■複数行コードの1行目（行頭に半角スペースが4個）
■■■■複数行コードの2行目（行頭に半角スペースが4個）

`複数行をバッククォートで囲むと、
改行が無視され、1行で表示されるので注意
`

番号無しリスト表示は、行頭にアスタリスクを入れます。番号有りリストは、行頭にピリオドを入れます。

例

*リスト１
*リスト2
*リスト3

.番号有りリスト1
.番号有りリスト2
.番号有りリスト3

水平線の表示は、アスタリスクやアンダースコアを3個以上になります。

例

アスタリスク3個以上
***

アンダースコア3個以上
___

文字列を強調する場合、アスタリスクで囲みます。さらに強く強調する場合、アスタリスク2個で囲みます。

例

アスタリスクで*強調*を行う

アスタリスク2個で**強い強調**を行う

リンクは、以下のようになります。

[タイトル](リンクURL)

例

[Yahoo](https://www.yahoo.co.jp/)