mdsf：一键美化你的 Markdown 代码块，让文档更优雅！

🚀 什么是 mdsf？

mdsf 是一个开源命令行工具，它能自动检测 Markdown 文件中的代码块，并用你喜欢的格式化工具来统一格式。
无论是 Python、Go、Rust、TypeScript 还是 Shell、C++、SQL……都能一键美化。

举个例子👇

然后——你的 Markdown 文档里的所有代码块，就都自动按照对应语言的风格格式化好了！

🌟 主要亮点

• 🧠 支持 300+ 格式化和校验工具
  内置支持各种语言的格式化器，例如 black（Python）、prettier（JS/TS）、rustfmt、gofmt 等。

• 🔗 多语言自动识别，灵活配置格式化链
  同一篇 Markdown 里混用多种语言？没问题，mdsf 会自动识别并调用对应的工具。
  还支持配置多级格式化链，比如先用 linter 校验，再格式化。

• ⚡ 缓存机制加速反复格式化
  重复格式化文档时，mdsf 会跳过未修改的部分，大幅提升速度。

• 🧩 编辑器与 CI 集成
  支持 VSCode、Vim、GitHub Actions 等，让你在写作或提交 PR 时自动保持代码风格统一。

• 📦 多平台安装简单
  不管你是用 npm、cargo、brew 还是 conda，都能快速安装。

  npm install -g mdsf
# 或者
cargo install mdsf


🛠️ 使用示例

1️⃣ 格式化单个文件

2️⃣ 批量格式化多个文件

3️⃣ 配置格式化规则

你可以在项目根目录添加 .mdsf.toml：

4️⃣ 集成 GitHub Actions

在 .github/workflows/format.yml 中添加：

这样，PR 提交时就能自动检测并格式化文档中的代码块。

💡 为什么推荐 mdsf？

在开源协作中，文档往往是展示项目风格与专业度的重要部分。
mdsf 的优势在于：

• 减少人工格式化的时间；

• 让不同语言的代码风格统一；

• 提升文档可读性与维护性；

• 集成方便，几乎无学习成本。

一句话总结：

📘 让 Markdown 文档里的代码块像你的项目代码一样干净整齐。

🧭 项目信息

• GitHub: https://github.com/hougesen/mdsf

• License: MIT

• 适合人群：开发者、技术写作者、开源贡献者、团队文档维护者

本文地址：https://www.navagpt.com/?p=2088&preview=true