Hexo 筆記好用套件:MarkdownLint
前言
在撰寫 Hexo 筆記時,Markdown 語法可以讓文章結構清晰、美觀。然而,隨著內容的增加,保持格式的一致性與規範性可能變得困難。此時,一個好用的套件就顯得尤為重要。今天,我要介紹的就是 MarkdownLint,這是一款能有效檢查 Markdown 文件的優秀工具。
MarkdownLint 是什麼?
MarkdownLint 是一個 Visual Studio Code 擴展,是可以協助用戶檢查 Markdown 文檔的語法和格式。它能自動識別並報告潛在的錯誤和不一致之處,使寫作過程更加流暢。
主要特點
實時檢查:MarkdownLint 在編輯 Markdown 筆記時會即時檢查語法,並在出現問題時提供提示,讓你能隨時修正錯誤,避免在發佈後才發現問題。
可自訂規則:根據需求設置檢查規則。以下是自訂規則的步驟:
文件參考:MarkdownLint 規則與別名
如何自訂規則
創建配置文件:
在 Markdown 項目根目錄下創建一個名為.markdownlint.json
的文件,以定義自訂規則。編輯配置文件:
在.markdownlint.json
中添加或禁用特定規則。以下是一些常見的參數設定:1
2
3
4
5{
"default": true,
"MD013": false, // 禁用行長度限制
"MD029": false // 禁用列表項前空格檢查
}儲存與應用:
保存.markdownlint.json
文件後,MarkdownLint 將自動加載這些設定,並在編輯 Markdown 文件時應用相應的規則。
快速安裝:此擴展安裝簡便,並且在 Visual Studio Code 中運行流暢,無需額外配置,讓你能快速上手。
如何安裝
- 打開 Visual Studio Code。
- 前往擴展市場(Extensions Marketplace)。
- 搜尋 “MarkdownLint” 或直接訪問 MarkdownLint。
- 點擊安裝即可。
如何查看錯誤
當出現問題時,MarkdownLint 會在有問題的行上顯示黃色波浪號
,這時你可以依照錯誤提示來進行修正,統一寫作風格。
結論
對於使用 Hexo 撰寫筆記的朋友們來說,MarkdownLint 是一個不可或缺的工具。它不僅提高了寫作效率,還幫助我們保持內容的一致性與質量。無論你是新手還是資深寫手,都能從中受益。快來試試這個好用的套件,讓你的 Hexo 筆記更上一層樓吧!