cover

你的 README.md 還是空的嗎?來,這篇教你用 Markdown 寫出讓人想看的 README。

先講結論

README 是別人認識你專案的第一印象。一個好的 README 至少要有:專案說明、安裝方式、使用方法、貢獻指南。以下整理 Markdown 最常用的語法,讓你的 README 不再只是 # Hello World

標題

# 標題 H1
## 標題 H2
### 標題 H3
#### 標題 H4

README 通常用 H1 當專案名稱,H2 分大段落,H3 分小段落。別用太多層級,超過 H4 就代表你的結構可能需要重新整理了。

文字樣式

*斜體*  **粗體**  ***粗斜體***  ~~刪除線~~

效果:斜體 粗體 粗斜體 刪除線

列表

- 無序列表項目
  - 巢狀項目
 
1. 有序列表
2. 第二項
 
- [x] 已完成的任務
- [ ] 未完成的任務

連結與圖片

[Google](https://www.google.com)
[錨點連結](#標題名稱)
![圖片說明](圖片網址)

錨點連結超好用,可以在 README 開頭做一個目錄,讓讀者快速跳到想看的段落。

引用

> 這是引用文字
> 適合放重要提醒或名言佳句

這是引用文字

程式碼

行內程式碼用單反引號:npm install

程式碼區塊用三個反引號加語言名稱:

```javascript
function hello() {
    console.log("Hello world!");
}
```

表格

| 欄位 | 說明 | 價格 |
|------|:----:|-----:|
| 左對齊 | 置中 | 右對齊 |
欄位說明價格
左對齊置中右對齊

Shields Badges

在 README 頂部加上 badge 讓你的專案看起來更專業:

![Build Status](https://img.shields.io/badge/build-passing-green)
![License](https://img.shields.io/badge/license-MIT-blue)

shields.io 可以生成各種 badge。

一個好的 README 結構

# 專案名稱
> 一句話描述
 
## 功能特色
## 安裝方式
## 使用方法
## API 文件(如果有的話)
## 貢獻指南
## 授權條款

README 寫得好不好,直接決定了別人願不願意用你的專案。不要再讓你的 README 只有一個 H1 了,拜託。


延伸閱讀