核心用法
MXE 是一款命令行 Markdown 导出工具,主打高质量文档转换。基础用法极为简洁:mxe document.md 即可生成 PDF。支持四种输出格式(PDF/DOCX/HTML/剪贴板),并通过 -f 参数切换。
关键特性详解
Mermaid 图表支持:内置 @mermaid-js/mermaid-cli 依赖,可将 Markdown 中的 Mermaid 语法实时渲染为矢量图,提供 5 种主题(default/forest/dark/neutral/base)和 ELK 布局引擎,满足技术文档的可视化需求。
排版定制:支持双字体系统——正文字体(6 种)与等宽代码字体(3 种),并允许通过 -s style.css 注入自定义样式,实现企业 VI 级别的文档标准化。
智能增强功能:自动生成 PDF 书签(可禁用)、TOC 目录、图片自动内嵌(base64 编码),以及 URL 直转功能(下载网页并转换),大幅减少手工操作步骤。
显著优点
- 零配置开箱即用:默认 Inter + JetBrains Mono 字体组合符合现代审美
- 技术友好:Mermaid 原生支持解决开发者文档痛点
- 输出专业度:自动书签、目录、矢量图表确保交付物可直接用于商务场景
- 灵活集成:剪贴板输出模式便于快速粘贴至协作工具(Notion/飞书等)
潜在局限
- Node.js 依赖:需预装 npm 环境,对非技术用户存在门槛
- Mermaid 外部依赖:
mmdc需单独全局安装,未内嵌可能导致版本冲突 - 字体版权隐忧:商用字体(如 Merriweather)的授权需用户自行确认
- 闭源工具链:虽本地运行,但源码位于用户目录下的 workspace,未明确开源协议
适合人群
- 技术团队:需批量生成 API 文档、架构图说明的技术写作者
- 产品经理:快速将 PRD Markdown 转为可交付的 PDF
- 研究人员:论文草稿转正式格式的过渡需求
- 开发者:构建自动化文档流水线的 CI/CD 场景
常规风险
| 风险项 | 评估 |
|--------|------|
| 数据泄露 | 低——本地处理,无网络上传(URL 下载除外) |
| 供应链攻击 | 中——依赖 npm 生态,需锁定版本防恶意包 |
| 输出文件安全 | 低——PDF/HTML 无主动执行代码能力 |
| 字体侵权 | 中——商业场景需核查字体授权 |
建议措施:生产环境使用 npm ci 锁定依赖,敏感文档优先用 --font inter(SIL Open Font License)。