Skip to content

格式檢查及自動補齊

如果您使用 Visual Studio Code 或 Cursor 來編寫 Zensical，建議安裝官方的 Zensical Studio 擴充套件。它會讀取專案的 zensical.toml，提供設定檔與 Markdown 的補齊、檢查與即時預覽。

Tip

這比以前幫 mkdocs.yml 掛 YAML Schema 更貼近實際專案：補齊內容會跟著你啟用的擴充與插件走。

安裝 Zensical Studio

在擴充套件市集搜尋 Zensical Studio，或用命令列安裝：

code --install-extension zensical.zensical-studio

Cursor 請在 Extensions 搜尋 Zensical Studio。若搜尋不到，確認擴充套件來源包含 Marketplace。

專案根目錄只要有 zensical.toml 或 mkdocs.yml，擴充套件就會自動啟動。

確認已啟用

打開任一 Markdown 檔後，檢查：

  1. 右下角語言模式是 Python Markdown
  2. 編輯器會標示壞掉的連結、未定義的 footnote、不存在的圖示 shortcode
  3. 編輯 zensical.toml 時會出現設定鍵的補齊與驗證

能幫你做什麼

  • 設定檔驗證：zensical.toml / mkdocs.yml 的補齊與錯誤提示
  • Markdown 診斷：失效連結、重複錨點、未使用的定義
  • 寫作輔助：Admonition、Tabs 自動縮排與語法高亮
  • 圖示補齊：依 pymdownx.emoji 與自訂圖示目錄提供 shortcode
  • 即時預覽：含 KaTeX、Mermaid（Studio 內建，不必另外載 CDN）

可選的工作區設定

如果專案還沒有 zensical.toml，仍想用 Studio 編輯 Markdown，可在 .vscode/settings.json 加入：

{
  "files.associations": {
    "*.md": "python-markdown"
  }
}

參考資料