社區文檔撰寫指南Markdown 語法上手( 先學這8種 )
概述
Markdown 是程序員必學技能之一，然而有時其豐富多樣的語法卻讓新人望而生畏。
此篇文章作為 Markdown 上手教程，只教授你 8 個最常用的語法，記住這幾個語法以后，就可以在你每篇文章中踐行。等具備足夠的使用經驗后，再進一步學習 完整的 Markdown 語法
1. 標題
語法格式：'#'+'空格'+'文本'
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題圖例：
注：
#和標題之間建議保留一個字符的空格，這是最標準的 Markdown 寫法；
一般情況下，文章的標題會被系統渲染為『一級標題』，所以請避免在文章內容中使用『一級標題』。
請善用二級和三級標題，wangan 文章模塊會自動為您生成 TOC，這會讓文章結構更加清晰，如下：
2. 列表
列表格式也很常用，在 Markdown 中，你只需要在文字前面加上 - 就可以了，例如：
- 文本一
- 文本二
- 文本三如果你希望有序列表，也可以在文字前面加上 1. 2. 3. 就可以了，例如：
1. 文本一
2. 文本二
3. 文本三圖例：
3. 鏈接和圖片
在 Markdown 中插入鏈接需要使用 [顯示文本](鏈接地址) 這樣的格式語法。例如：
[wangan 社區](https://wangan.com)在 Markdown 中，插入圖片不需要其他按鈕，你只需要使用這樣的語法即可，例如：
注：插入圖片的語法和鏈接的語法很像，只是前面多了一個 !。
圖例：
wangan 上圖片顯示時會加陰影，如果你想去除陰影的話，可以使用以下方式：
<img src="https://upload.nsg.cn/uploads/images/202006/10/2/PQwyT4WIsE.jpg!large" class="rm-style">圖例：
注：wangan 編輯器上傳圖片，只需要將圖片拖拽丟入『編輯窗口』內，或者復制圖片在『編輯窗口』內黏貼即可上傳。
4. 引用
寫作時經常需要引用他人的文字，在 Markdown 中，你只需要在你希望引用的文字前面加上 > 即可，例如：
Markdown 是一種輕量級標記語言，它允許人們使用易讀易寫的純文本格式編寫文檔，然后轉換成格式豐富的 HTML 頁面。
圖例：
5. 行內代碼
行內的代碼使用 ` 包起來即可，一般在描述類、函數、文件名稱及路徑時使用，如：
wangan 框架的所有配置文件都保存在 `config` 目錄中。可以使用 `config()` 輔助函數來讀取。圖例：
6. 代碼高亮
如下是代碼段的語法：
```編程語言 這是代碼段 ```
例如：
```php
class Order extends Model
{
...
public function scopeDelivered($query) {
return $query->where('status', 'delivered');
}
public function scopePaid($query) {
return $query->where('paid', true);
}
}
$orders = Order::delivered()->paid()->get();
```
圖例：
注：在 wangan 上，每一個社區都設定了默認的代碼高亮語法，例如 PHP 和 wangan 社區默認使用
php作為默認高亮語法，當你只使用```而未設置語法時，此功能會被用上。
7. 粗體和斜體
Markdown 的粗體和斜體非常簡單，用兩個 * 包含一段文本就是粗體的語法，用一個 * 包含一段文本就是斜體的語法。例如：
Markdown 的 **粗體** 和 *斜體* 非常簡單。最終顯示的就是下文：
Markdown 的 粗體 和 斜體 非常簡單。
圖例：
8. 表格
基礎的表格語法：
項目 | 價格
-------- | ---
iPhone | $560
iPad | $780
iMac | $1000可以使用冒號來定義對齊方式：
| 項目 | 價格 | 數量 |
| :-------- | --------:| :--: |
| iPhone | 6000 元 | 5 |
| iPad | 3800 元 | 12 |
| iMac | 10000 元 | 234 |
圖例：
結語
Markdown 編寫是開發者的必備技能，尤其在撰寫技術文檔上，更加離不開 Markdown 語法。如果對 Markdown 語法不熟悉，本篇文章羅列了使用頻率最高的 8 個語法，你可以多看幾遍，或者打開 編輯器 直接嘗試，這樣會記得更加牢固。
在掌握了以上的簡單語法后，推薦查閱 完整 Markdown 語法。