おすすめ記事

【Github】READMEの書き方まとめ

見出し

先頭に#をレベルの数だけ記述します。1から6まであります。

段落

空白行を挟むことで段落となります。

改行

改行の前に半角スペース を2つ記述します。

引用

先頭に>を記述します。ネストは>を多重に記述します。

コード

バッククオート 3つ、あるいはダッシュ~3つで囲みます。

インラインコード

バッククオート で単語を囲むとインラインコードになります。

水平線

アンダースコア_ 、アスタリスク*などを3つ以上連続して記述します。

リスト

UI箇条書きリスト

ハイフン-、プラス+、アスタリスク*のいずれかを先頭に記述します。ネストはタブで表現します。

OI番号付きリスト

番号.を先頭に記述します。ネストはタブで表現します。
番号は自動的に採番されるため、すべての行を1.と記述するのがお勧めです。

リンク

[表示文字](URL)でリンクに変換されます。

強調

イタリック

アスタリスク*もしくはアンダースコア_1個で文字列を囲みます。

太字

アスタリスク*もしくはアンダースコア_2個で文字列を囲みます。

イタリック+太字

アスタリスク*もしくはアンダースコア_3個で文字列を囲みます。

画像

先頭の!で画像のと認識されます。画像の大きさなどの指定をする場合はimgタグを使用します。

-|を使ってtableを作成します。