清單(Lists)
Zensical 支援多種清單:無序清單與有序清單是標準 Markdown,定義清單與任務清單則要靠擴充。
zensical.toml 設定
定義清單與任務清單不是標準 Markdown 語法,需要啟用:
[project.markdown_extensions]
def_list = {}
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
無序清單
行首用 -、* 或 + 都可以,三者可以互換。各種清單也可以互相巢狀:
原始程式
輸出結果
- 第一層項目
- 第二層項目
- 另一個第二層項目
- 另一個第一層項目
縮排要四個空格
Python Markdown 要求子項目縮排四個空格(或一個 Tab),其他 Markdown 實作只需要兩個。另外,Python Markdown 在清單符號改變時(例如從 * 換成 -)不會另開新清單,這和 CommonMark 不同。
有序清單
數字後面接一個點。數字不必連續,甚至可以全部寫 1.,渲染時會自動重新編號:
原始程式
輸出結果
- 安裝 Zensical
- 建立虛擬環境
- 執行
pip install zensical
- 建立專案
- 啟動預覽
定義清單
適合列舉「名詞 → 說明」,例如函式的參數或設定的欄位。名詞獨立一行,說明用 : 開頭並縮排四個空格:
原始程式
輸出結果
site_name- 網站名稱,必填。
site_url-
網站的正式網址。
可以有多個段落, 只要每行都縮排四個空格。
任務清單
在無序清單的項目前面加 [ ](未完成)或 [x](已完成),就會變成核取方塊:
原始程式
輸出結果
- 安裝 Zensical
- 設定顏色
- 選擇主色
- 選擇強調色
- 佈署到 GitHub Pages
Note
核取方塊預設是唯讀的,只能在 Markdown 原始碼中改變勾選狀態。
總結
| 清單類型 | 語法 | 需要擴充 |
|---|---|---|
| 無序清單 | -、*、+ |
標準 |
| 有序清單 | 1. |
標準 |
| 定義清單 | 名詞 換行 : 說明 |
def_list |
| 任務清單 | - [x]、- [ ] |
pymdownx.tasklist |