Markdown 簡介
Markdown 是一種輕量級的標記語言,於 2004 年由 John Gruber 和 Aaron Swartz 共同創建。Markdown 的設計理念是「易於讀寫」。其核心思想在於,標記語言的格式應該是透明的,對讀者來說,即使不加任何格式化也應該便於閱讀。Markdown 文件通常以 .md
或 .markdown
為檔案擴展名。
Markdown 的應用與優勢
- 版本控制相容性:由於 Markdown 是純文字格式,它非常適合用 Git 進行版本控制。這意味著使用 Markdown 的文檔可以輕鬆地追蹤更改歷史、合併不同版本,以及進行差異比較。
- 廣泛採用:許多代碼託管平台和開發工具,如 GitHub、GitLab 和 Azure DevOps,都支援 Markdown 格式。在這些平台上,Markdown 被用於編寫說明文件、技術文檔、博客文章等。
- README 文件標準:在許多開源項目中,Markdown 成為撰寫 README 文件的首選格式。它使得開發者可以用一種格式簡潔且具可讀性的方式來介紹和說明他們的項目。
Markdown 的基本語法
- 標題:使用不同數量的井號
#
來表示不同層級的標題。 - 段落和換行:普通的文本會被轉換成段落,行末加兩個空格則表示換行。
- 強調和斜體:用星號
*
或下劃線_
來標記。 - 列表:使用星號
*
、加號+
或減號-
創建無序列表;數字接點1.
則用於有序列表。 - 鏈接和圖片:使用方括號
[]
來標記鏈接文本,圓括號()
來包含 URL;圖片則在前面加上驚嘆號!
。 - 代碼:使用反引號 ` 來標記單行代碼,三個反引號則用於多行代碼塊。
- 引用:使用大於號
>
來標記引用文字。
基本語法的範例
標題
Markdown 使用井號 #
來創建標題。標題級別由井號的數量決定(1-6個)。
# 這是一級標題
## 這是二級標題
### 這是三級標題
#### 這是四級標題
##### 這是五級標題
###### 這是六級標題
段落和換行
段落由一行或多行文本組成。在 Markdown 中,段落之間用一個空行隔開。
這是第一段。
這是第二段。
要在行內創建換行,你可以在行尾加上兩個空格,然後換行。
強調和斜體
使用星號 *
或下劃線 _
來創建斜體或加粗的文字。
*這些文字會顯示為斜體*
_這些文字也會顯示為斜體_
**這些文字會顯示為加粗**
__這些文字也會顯示為加粗__
列表
無序列表使用星號 *
、加號 +
或減號 -
創建。
- 項目一
- 項目二
- 項目三
有序列表則使用數字接點創建。
1. 第一項
2. 第二項
3. 第三項
鏈接和圖片
在方括號中放入鏈接文字,然後在圓括號中放入 URL 來創建鏈接。
[OpenAI](https://www.openai.com)
圖片語法與鏈接類似,但在前面加上驚嘆號 !
。
![Alt 文本](圖片網址)
代碼
單行代碼使用反引號 ` 包圍。
`這是一行代碼`
多行代碼則使用三個反引號包圍,並且可以指定語言。
```python
print("Hello, World!")
```
引用
使用大於號 >
來標記引用文字。
> 這是一段引用文字。
表格
表格的基本語法
表格的語法使用豎線 |
和連字號 -
來定義列和行。簡單表格示範例如下:
| 表頭一 | 表頭二 | 表頭三 |
| ------ | ------ | ------ |
| 行一列一 | 行一列二 | 行一列三 |
| 行二列一 | 行二列二 | 行二列三 |
| 行三列一 | 行三列二 | 行三列三 |
表頭一 | 表頭二 | 表頭三 |
---|---|---|
行一列一 | 行一列二 | 行一列三 |
行二列一 | 行二列二 | 行二列三 |
行三列一 | 行三列二 | 行三列三 |
對齊方式
你還可以在表格中指定列的對齊方式。在連字號下方加入冒號 :
可以指定左對齊、右對齊或居中對齊。
- 左對齊:在左側加冒號 :--
- 右對齊:在右側加冒號 --:
- 居中對齊:兩側都加冒號 :--:
例如:
| 左對齊 | 居中對齊 | 右對齊 |
| :----- | :------: | -----: |
| 文本一 | 文本二 | 文本三 |
| 文本四 | 文本五 | 文本六 |
產生的表格會像這樣:
左對齊 | 居中對齊 | 右對齊 |
---|---|---|
文本一 | 文本二 | 文本三 |
文本四 | 文本五 | 文本六 |
參考資料:
- Markdown - Wiki
- Markdown Guild
- Markdown 語法說明