おすすめ記事

【Github】READMEの書き方まとめ

  /
目次
  1. 見出し
  2. 段落
  3. 改行
  4. 引用
  5. コード
  6. インラインコード
  7. 水平線
  8. リスト
  9. リンク
  10. 強調
  11. 画像
  12. 表

見出し

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

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

段落

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

段落1
(空行)
段落2

改行

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

hoge
fuga(スペース2つ)
piyo

引用

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

> 引用  
> 引用
>> 多重引用

コード

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

```print'hoge'```
~~~print'hoge'~~~

インラインコード

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

これは `インラインコード`です。

水平線

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

hoge
***
hoge
___

リスト

UI箇条書きリスト

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

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

OI番号付きリスト

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

1. 番号付きリスト1
    1. 番号付きリスト1-1
    1. 番号付きリスト1-2
1. 番号付きリスト2
1. 番号付きリスト3

リンク

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

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

強調

イタリック

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

これは *イタリック* です
これは _イタリック_ です

太字

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

これは **ボールド** です
これは __ボールド__ です

イタリック＋太字

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

これは ***イタリック＆ボールド*** です
これは ___イタリック＆ボールド___ です

画像

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

![alt](画像URL)
![代替文字列](URL "タイトル")

<img src="attach:cat.jpg" alt="attach:cat" title="attach:cat" width="200" height="200">

表

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

| TH1 | TH2 |
----|---- 
| TD1 | TD3 |
| TD2 | TD4 |
| 左揃え | 中央揃え | 右揃え |
|:---|:---:|---:|
|1 |2 |3 |
|4 |5 |6 |
関連記事