SuperAPI AI 工具集

markpress

办公与效率

查看项目

更新于 10-16 06:23

技能介绍

用途:MarkPress 是把本地 Markdown 转成 PDF 的 CLI 工具,适合生成报告、开发者文档和白皮书等交付物。仅接受本地 .md 文件,不支持远程 URL。

主要能力:内置模板(default 简洁、github 风格、magazine 编辑排版)、语法高亮、Mermaid 图表自动渲染为 SVG,支持流程图、时序图、类图、状态图、ER 图、甘特图等,适用于所有模板。支持 YAML frontmatter,title 字段决定 PDF 的 <title>,无 frontmatter 时默认 "Document"。

安装:npm install -g @liustack/markpress@latest,然后 npx playwright install chromium。使用前可运行 markpress --version 检查版本。

使用方式:markpress -i input.md -o output.pdf --template default,参数包括 -i/--input、-o/--output、-t/--template(default、github、magazine)、--safe(禁用外部网络请求与 JavaScript 执行)、--wait-until(load、domcontentloaded、networkidle)、--timeout(毫秒)。

适用场景:已有 .md 文件直接渲染;没有文件但需要报告时,先写 Markdown 内容再渲染;有数据或代码需总结时,先创建含标题、表格、代码块的 Markdown 报告再渲染。文档用途决定模板:技术文档与报告用 default,README 风格开发者文档用 github,追求精致排版用 magazine。

限制与注意事项:不支持远程 URL;渲染可能含脚本的 Markdown 时用 --safe 阻断网络与脚本。生成文件应统一放入 $ASSETS_DIR(默认 ${workspaceRoot}/assets),成功后及时删除临时文件,除非用户要求保留。其余细节暂未提供。