写给用 Markdown 写技术文档的人:用 Mermaid 画图,直接导出为 Word 的 Markdocx

在上一篇文章“双击 .md 文件却没法好好阅读?”中,我们介绍了如何把 Markdocx 当作 .md 文件的阅读器来使用。其实 Markdocx 不只能读,也是一款用来写的应用。

这次我们面向写设计文档、规格说明、操作手册等技术文档的人,介绍 Markdocx 的两项功能:用文本画图的 Mermaid 写法,以及导出为 Word(.docx)。Markdocx 有 Mac 版和 Windows 版,用法相同。

写技术文档时,你是否也遇到过这些情况?

  • 想用 Markdown 写正文并用 Git 管理,可交付物规定必须是 Word
  • 图是在 PowerPoint 等其他软件里画好再作为图片贴进来的,稍作修改就得重画、重贴
  • 想用 Pandoc 转换成 Word,却需要安装和命令行操作,要把 Mermaid 图表放进去还得再用别的工具

用 Markdocx,写作、画图和导出为 Word 都能在一个应用里完成。

用文本画图(Mermaid)

Mermaid 是一种用文本来写图表的写法。例如,订单的处理流程可以这样写:

```mermaid
sequenceDiagram
    participant U as 用户
    participant A as 订购应用
    participant S as API 服务器
    U->>A: 点击下单按钮
    A->>S: POST /orders
    S-->>A: 201 Created
    A-->>U: 显示下单完成
```

Markdocx 内置 Mermaid,写下这样的代码块(语言设为 mermaid)后,预览中会立即显示图表。

Mac 版 Markdocx:左侧是 Markdown,右侧是包含时序图的预览
Mac 版 Markdocx。左侧的代码会在右侧的预览中变成时序图
  • 可以绘制流程图、时序图、类图、状态图、ER 图、甘特图、饼图、思维导图、时间线和 Git 图共 10 种图表
  • 可以从工具栏一键插入 10 种模板。即使不熟悉写法,也可以从修改模板开始
  • 图表也是文本,所以可以在 Git 中查看差异,审阅也更方便。修改时只需改写文字
  • 可从 6 种配色中选择,既可应用于整个应用,也可按文档设置
  • 图表在电脑中绘制,不需要联网,不能外传的文档也可以放心编写
  • 让 AI 讲解处理流程或系统结构时,它常常会用 Mermaid 返回图表。直接粘贴进来,就会显示成图表
Windows 版 Markdocx 的图表模板菜单
Windows 版 Markdocx。可以从工具栏插入 10 种图表模板

直接导出为 Word

写好的文档,只需点击工具栏中的导出按钮并选择 Word(.docx),就能变成 Word 文档。

  • 标题、列表、表格、代码块和图片会原样进入 Word 文档
  • Mermaid 图表会以图片形式嵌入 Word 文档。收到文档的人只用 Word 就能看到图表
  • Word 文档由 Markdocx 自己生成,不需要 Pandoc 等工具,也不需要命令行操作
  • 也可以导出为 PDF、EPUB 和 HTML。在 HTML 和 EPUB 中,图表是矢量图,放大后依然清晰
  • 反过来,也可以读取 Word 文档(.docx),用 Markdown 继续写作。把以往用 Word 写的文档迁移到 Markdown 时很方便
Windows 版 Markdocx 的导出菜单:Markdown、HTML、PDF、Word、EPUB
Windows 版 Markdocx 的导出菜单。可从 Markdown、HTML、PDF、Word 和 EPUB 中选择
用 Word 打开从 Markdocx 导出的 Word 文档:标题、正文、时序图和表格
用 Word 打开从 Markdocx 导出的 Word 文档。标题、正文、表格和 Mermaid 时序图都原样保留

在用 Word 交换文档的职场,使用 Windows 的人可能比较多。Markdocx 也有 Windows 版,既可以在 Windows 上写好交出去,也可以在 Mac 上写好,用 Word 发给使用 Windows 的同事。导出的 Word 文档在 Windows 和 Mac 的 Word 中都能直接打开。

以 Markdown 的形式管理

Markdocx 可以直接打开普通的 .md 文件进行写作。用 Git 保留历史、通过差异进行审阅,只在交付时导出为 Word,这样的分工就能实现。如果想把图片也放进同一个文件,还可以保存为 .markdocx 格式。

价格与系统要求

前 14 天可免费使用全部功能。之后,写作、预览和图表依然可以无限期免费使用。导出为 Word 等格式以及读取 Word 文档,需一次性购买后解锁(Mac 版在 Mac App Store,Windows 版在 Microsoft Store,分别购买)。不是订阅制。

Mac 版适用于 macOS 26 或更高版本,Windows 版适用于 Windows 11 和 Windows 10(版本 1809 或更高)。

→ 查看 Markdocx 的详情

→ 在 Mac App Store 中查看

→ 在 Microsoft Store 中查看

更多 Markdocx 相关文章