🌕

README.mdの書き方

2021/12/20に公開

太文字

**太文字**

見出し

シャープ(#) + 半角スペース
行頭の#の個数でH1~H6を表す

# H1見出し
## H2見出し
### H3見出し

段落

空行をあける

1段落目
(空行をはさむ)
2段落目

改行

行末に半角スペースを2回入れる
または、<br>

#半角スペースの場合
テスト(半角スペース2回)
テスト1

#brタグの場合
テスト<br>
テスト1

表示結果

テスト
テスト1

リスト

行頭にハイフン(-)+ 半角スペース
ネストはタブで表現

- リスト1
    - リスト1_1
    - リスト1_2
- リスト2
- リスト3

リンク

自動リンク

アングルブラケット<>でURLを囲う
メールアドレスでも可能

<http://example.com>
<example@example.com>

通常のインライン記法

[リンクのテキスト](リンクのアドレス)

[Google](https://www.google.co.jp/)

画像を表示

  1. GitHub、画像を表示させたいリポジトリで新規issueを作成
  2. 作成したisssueのコメントに、表示させたい画像をドロップ
  3. 生成された画像URLをREADME.mdにペースト
    issueはcloseする。

中央揃え(テキスト)

<p align="center">
  テキスト
</p>

中央揃え(見出し)

<h1 align="center"> 
   見出し 
</h1>

中央揃え(画像)

<p align="center">
  <a href="画像へのリンク">
    <img width="100px" src="画像へのリンク" />
  </a>
</p>

画像へのリンクは、上記「画像を表示」内、画像URLのhttps://user-images~部分

Discussion