Markdown文档导出Markdown文档导出
Markdown文档导出

技能简介

MXE是一款命令行工具,用于将Markdown文件转换为PDF、DOCX或HTML格式,支持Mermaid图表渲染、自定义字体、目录生成等功能。

业务背景

MXE帮助团队将技术文档、产品手册等Markdown内容快速转化为专业格式的交付物,省去手动排版的重复劳动。支持图表渲染、目录生成和样式定制,满足对外发布、客户交付或内部归档等多场景需求,让技术人员专注内容创作而非格式调整。

落地案例:产品经理需将需求文档转为PDF供客户审阅。她使用MXE指定输出格式为PDF,工具自动解析文档中的Mermaid流程图并嵌入,同时根据标题层级生成可点击目录;若客户要求Word版本,仅需修改参数即可导出DOCX,保持排版一致性,大幅提升多格式交付效率。

能做什么

  • Markdown转换为排版精美的PDF文档
  • 导出包含Mermaid流程图/时序图的文档
  • 自动生成可点击的目录和PDF书签
  • 从网页URL下载并转换为Markdown或PDF
  • 支持Word(docx)和HTML多种输出格式

使用说明

1. 检查安装状态

which mxe || echo "Not installed"

2. 安装(如未安装)

cd /Users/tuan/.openclaw/workspace/mxe && npm run build && npm link

3. 基础用法

# 简单PDF转换
mxe document.md

# 带目录生成
mxe document.md --toc

# 指定输出目录
mxe document.md -o ./output

# 自定义字体
mxe document.md --font roboto --mono-font fira-code

# Mermaid图表主题
mxe document.md --mermaid-theme forest --hand-draw

4. 常用参数

  • -f pdf/docx/html/clipboard:指定输出格式
  • --font:正文字体(inter/roboto/lato等)
  • --mono-font:代码字体(jetbrains-mono/fira-code等)
  • --mermaid-theme:图表主题(default/forest/dark等)
  • -s style.css:加载自定义CSS样式

输入与输出

见下方输入与输出表格。

项目内容
输入Markdown文件(.md)、网页URL、可选CSS样式表
输出PDF(默认)/DOCX/HTML文件,或剪贴板文本
适用人群技术写作者、开发者文档维护人员、需要将Markdown转为正式交付物的人员
不包含在线编辑器、云同步、团队协作审阅、模板商店

 

风险提示

  • Mermaid图表需预先安装npm i -g @mermaid-js/mermaid-cli
  • 本地图片会被base64编码嵌入PDF,可能增加文件体积
  • 网络文章下载依赖外部站点可用性
  • 自定义CSS语法错误可能导致渲染异常

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/tuanpmt/mxe/SKILL.md
来源类型:GitHub仓库

数据统计

相关导航

暂无评论

none
暂无评论...