爲什麼要學 Markdown
每次寫技術文檔、README、博客文章,都要在富文本編輯器裏點來點去調格式?Markdown 能讓你只用鍵盤就寫出結構清晰的文檔,寫完直接轉 HTML,在 GitHub、Notion、語雀、掘金等平臺上開箱即用。
學一次,到處能用。
基礎語法
標題
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
# 和標題文字之間必須有一個空格,否則部分解析器不識別。
段落與換行
Markdown 裏直接按回車不會換行——這是最常見的新手困惑。
這是第一行
這是第二行(和上面在同一段落)
這是新段落(空一行纔會分段)
強制換行的兩種方法:
- 行尾加兩個空格再回車
- 行尾加
\(部分平臺支持)
強調
*斜體* 或 _斜體_
**粗體** 或 __粗體__
***粗斜體*** 或 ___粗斜體___
~~刪除線~~
效果:斜體、粗體、粗斜體、刪除線
列表
無序列表(-、*、+ 均可):
- 蘋果
- 香蕉
- 大蕉(嵌套,縮進2個空格)
- 小米蕉
- 橙子
有序列表:
1. 第一步
2. 第二步
3. 第三步
有序列表的數字不影響最終渲染順序,全寫
1.也會自動編號,但建議按序寫便於閱讀源碼。
鏈接
[鏈接文字](https://toolshu.com)
[帶標題的鏈接](https://toolshu.com "鼠標懸停顯示的標題")
<!-- 引用式鏈接,適合文中多次引用同一URL -->
[toolshu][1]
[1]: https://toolshu.com
圖片


Markdown 原生不支持指定圖片尺寸,如需控制大小需用 HTML:
<img src="https://example.com/image.png" width="300" alt="描述">
引用塊
> 這是引用內容
> 可以多行
>
> 空行保留引用塊
> 引用塊可以嵌套
>> 二級引用
>>> 三級引用
代碼
行內代碼:用反引號包裹
執行 `npm install` 安裝依賴
代碼塊:用三個反引號包裹,後面加語言名開啓語法高亮
```javascript
const greeting = "Hello, World!";
console.log(greeting);
```
常用語言標識:javascript、python、java、bash、sql、json、css、html、go、rust
分割線
---
***
___
三種寫法效果一樣,推薦用 ---,視覺上最清晰。
進階語法(GFM)
以下語法屬於 GitHub Flavored Markdown(GFM),在 GitHub、GitLab、大多數主流平臺均支持,但不在原始 Markdown 規範內。
表格
| 名稱 | 類型 | 描述 |
|----------|--------|----------------|
| id | int | 用戶唯一標識 |
| username | string | 用戶名 |
| email | string | 郵箱地址 |
對齊控制:
| 左對齊 | 居中對齊 | 右對齊 |
|:---------|:--------:|---------:|
| 內容 | 內容 | 內容 |
表格小技巧:列寬不用對齊,解析器會自動處理,但對齊了源碼更易讀。
任務列表
- [x] 已完成的任務
- [ ] 未完成的任務
- [x] 另一個已完成項
GitHub、Notion、語雀等平臺會渲染成可勾選的複選框。
腳註
這裏有個需要說明的內容[^1]。
[^1]: 這是腳註內容,會顯示在文章底部。
自動鏈接
直接寫 URL 會自動變成鏈接:https://toolshu.com
或者用尖括號:<https://toolshu.com>
代碼塊內的轉義
如果代碼塊本身要包含三個反引號,外層用四個反引號包裹:
````
```這裏是三個反引號,不會被解析```
````
容易踩的坑
1. 列表後接代碼塊需要空行
- 列表項
代碼塊(用4個空格縮進,或空行後用圍欄式)
2. 標題前需要空行
上一段文字
## 標題(前面空一行才能正確解析)
3. 同一段落內加粗不能跨行
**這是粗體
換行後不生效** ← 部分解析器會失效
4. 表格單元格里不能直接換行
表格單元格里需要換行時,用 <br> 標籤:
| 列1 | 列2 |
|------------------|-------|
| 第一行<br>第二行 | 內容 |
各平臺差異速覽
| 平臺 | GFM表格 | 任務列表 | 腳註 | 數學公式 |
|---|---|---|---|---|
| GitHub | ✅ | ✅ | ✅ | ✅($$) |
| Notion | ✅ | ✅ | ❌ | ✅ |
| 語雀 | ✅ | ✅ | ❌ | ✅ |
| 掘金 | ✅ | ✅ | ✅ | ✅ |
| VS Code 預覽 | ✅ | ✅ | ✅ | 需插件 |
寫完 Markdown 想直接看 HTML 渲染效果,或者手上有一段 HTML 想轉成 Markdown 來編輯,可以用 Markdown/HTML 互轉工具,粘進去實時預覽,省去搭本地環境的麻煩。



加載中...