Markdown 基本語法
Markdown 是一種輕量級標記語言,排版語法簡潔,讓人們更多地關注內容本身而非排版。它使用易讀易寫的純文本格式編寫文檔,可與HTML混編,可導出 HTML、PDF 以及本身的 .md 格式的文件。
設計理念
Markdown 的目標是實現「易讀易寫」。
可讀性,無論如何,都是最重要的。一份使用 Markdown 格式撰寫的文件應該可以直接以純文本發布,並且看起來不會像是由許多標簽或是格式指令所構成。
Markdown 語法的首要設計目標是盡可能易讀。基於這個目標,Markdown 格式的文檔能夠以純文本形式原樣發布,而不會看起來像被填滿了標簽或格式化指令。
—— John Gruber
兼容 HTML
Markdown 語法的目標是:成為一種適用於網絡的書寫語言。
Markdown 不是想要取代 HTML,甚至也沒有要和它相近,它的語法種類很少,只對應 HTML 標記的一小部分。
不在 Markdown 涵蓋范圍之內的標簽,都可以直接在文檔裡面用 HTML 撰寫。不需要額外標注這是 HTML 或是 Markdown;只要直接加標簽就可以了。
例如,在 Markdown 文件裡加上一段 HTML 表格:
這是一個普通段落。
<table>
<tr>
<td>Foo</td>
</tr>
</table>
這是另一個普通段落。
特殊字符自動轉換
在 HTML 文件中,有兩個字符需要特殊處理:<
和 &
。
<
符號用於起始標簽&
符號則用於標記 HTML 實體
Markdown 讓你可以自然地書寫字符,需要轉換的由它來處理好了。如果你使用的 &
字符是 HTML 字符實體的一部分,它會保留原狀,否則它會被轉換成 &
。
基本語法元素
Markdown 基本語法包括以下元素:
塊級元素
內聯元素
其他
語法示例
下面是一個包含多種基本語法的示例:
# 我的文檔
這是一個**粗體文本**和一個*斜體文本*的例子。
## 列表示例
### 購物清單
- 蘋果
- 香蕉
- 橙子
### 任務列表
1. 學習 Markdown 基本語法
2. 練習寫作
3. 分享給朋友
> 這是一個引用塊的例子。Markdown 讓寫作變得簡單而優雅。
這是一個[鏈接到首頁](/zh/)的例子。
代碼示例:
你也可以使用行內代碼,比如 console.log('Hello World')
。
最佳實踐
標題使用
- 每個文檔只使用一個一級標題 (
#
) - 保持標題層級的邏輯性,不要跳級
- 在標題前後留空行
列表格式
- 無序列表保持符號一致性(統一使用
-
、*
或+
) - 列表項之間不需要空行,除非包含多個段落
鏈接和圖片
- 為鏈接提供有意義的文本描述
- 為圖片提供替代文本(alt text)
代碼展示
- 短代碼使用行內代碼格式
- 長代碼或多行代碼使用代碼塊
- 為代碼塊指定語言以獲得語法高亮
工具支持
幾乎所有 Markdown 應用程序都支持這些基本語法元素。不同的 Markdown 處理器之間可能存在細微差異,但基本語法是通用的。
下一步
現在你已經了解了 Markdown 基本語法的概述,可以:
開始學習具體的語法元素: