markdown-formatter

📝 专业级 Markdown 文档美化工具

🥥5总安装量 1评分人数 1
100% 的用户推荐

Vernox 出品的 Markdown 格式化工具,支持多种风格指南与批量处理,让技术文档瞬间专业规范。

A

基本安全,请在特定环境下使用

  • 来自社区或个人来源,建议先隔离验证
  • ✅ 无危险函数调用(无 eval/exec/system/subprocess)
  • ✅ 零外部依赖,仅使用 Node.js 内置 fs/path 模块
  • ✅ 无网络通信、无数据上传,完全本地处理
  • ⚠️ formatBatch 函数读取用户指定文件路径,需确保路径可信
  • ⚠️ 建议 SKILL.md 中明确说明文件读取权限需求

使用说明

Markdown-Formatter 是一款专注于 Markdown 文档美化与格式化的实用工具,由个人开发者 Vernox 基于 MIT 协议开源。该技能核心提供三大功能模块:格式化引擎(支持 CommonMark、GitHub Flavored Markdown 等风格指南)、代码清理与校验(修复列表标记不一致、规范化空白字符、优化标题层级)、以及批量处理能力(可同时处理多个本地文件)。

显著优点体现在其高度可配置性——用户可精细控制行宽、标题样式、列表符号、代码块格式、强调方式等十余项参数,且完全基于 Node.js 内置模块实现,零外部依赖保证了极佳的稳定性与可移植性。对于技术写作者和开源维护者而言,它能快速统一 README、API 文档、博客文章的风格,显著提升内容专业度。

潜在局限性包括:作为 T3 来源的个人项目,长期维护与社区支持存在不确定性;功能聚焦于格式层面,不涉及 Markdown 到 HTML/PDF 等格式的转换;批量处理时若传入不可信文件路径可能存在路径遍历风险;对复杂嵌套表格或特定扩展语法的支持可能不如专业编辑器完善。

目标用户群体明确:开源项目维护者(规范化 README)、技术文档工程师(统一团队文档风格)、内容创作者(美化博客与教程)、以及需要将 LLM 生成内容整理为规范格式的开发者。尤其适合需要批量处理大量 Markdown 文件、或对代码风格一致性有严格要求的场景。

使用风险方面,该技能完全本地运行、无网络通信,数据隐私风险极低。主要注意事项在于 formatBatch 函数会读取用户指定的本地文件路径,需确保路径来源可信;此外处理超大文档(5000+ 词)时耗时可能达 200-500ms,批量处理大量文件时建议分批次执行以避免阻塞。

markdown-formatter 内容

手动下载zip · 9.3 kB
config.jsonapplication/json
请选择文件