Markdown格式化
mdformat
使用工具mdformat,项目README有教程。
pip方式安装:
bash
pip install mdformat
pip inject mdformat mdformat-gfm
主要用法:
bash
mdformat README.md CHANGELOG.md directory
mdformat .
mdformat --check README.md CHANGELOG.md
问题:会把加粗的**
格式化成\*\*
,导致vitepress无法解析。
markdownlint
github主页:https://github.com/DavidAnson/markdownlint
npm全局安装:
bash
npm install -g markdownlint-cli
基本使用:
bash
markdownlint "**/*.md"
markdownlint README.md
markdownlint -f README.md # 修复问题
配置文件.markdownlint.json
:
json
{
"default": true,
"MD007": { "indent": 4 },
"MD013": false,
"MD033": false,
"MD034": false,
"MD036": false,
"MD041": false,
"MD045": false,
"no-hard-tabs": false
}