目錄

VSCode Markdown 開發環境

正文

介紹一下 VSCode 寫 Markdown 的環境設定,會有各種 Extension 安裝

Markdown All in One

最重要的套件,功能包含像是各種快捷健 (ctrl + b = 粗體),list 按下 enter 會自動補另外一個 list,截圖直接 ctrl + v 可以直接產生 image.png 並且直接展示在 markdown 文件。

除此之外,此套件還有提供把 Markdown 轉成 HTML 的功能。

markdownlint

Lint 靜態分析工具,會在 VSCode 提示體不符合規則的地方 (規則以 MD 開頭),規則主要來至設計師 David Anson 的設計,但有不喜歡的規則可以用 JSON 停用。

信息

David Anson 是一位資深的軟體工程師,目前在 Microsoft(微軟) 工作。他在軟體開發領域有超過 20 年的經驗,專長於 Web 技術、使用者介面(UI)以及開發者工具。

他非常推崇 CommonMark 標準,致力於解決 Markdown 解析歧義的問題。

markdownlint 警告
markdownlint 警告

如上有不同的規則違反,可以手動一個一個點 Fix,但更快的方式可以用 ctrl + shift + p 可以打 “Fix all supported markdownlint violations in the document” 可以修復所有內容。

但並非所有規則都支援自動修復,像是 MD055/table-pipe-style 檢查的是 Markdown 表格兩端的垂直線 (|),就無法自動修復,你要手動補上開頭結尾的垂直線。

Markdown PDF

可以把 Markdown 轉成 PDF。

Markdown Tab 問題

另外一個常常遇到的是,Markdown Tab 問題,因為不管是 VSCode or Vim 都有自己的 config,所以我這邊強是用 Editconfig 設定 *.md 的規則,強制規定 Tab 要用 Space 並且為 4 個 spaces,換行用 lf 等 …

root = true

[*.md]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 4

並且 VSCode 要安裝相關的 Extension - “EditorConfig”。

Reference