@nationstech/ns-md-cli

将 Markdown 导出为 PDF 或 DOCX 的命令行工具，命令名为 ns-md。

快速开始

npm i -g @nationstech/ns-md-cli
ns-md --help

最常用命令：

# 默认导出 PDF
ns-md --input "D:\docs\spec.md"

# 导出 DOCX
ns-md --type docx --input "D:\docs\spec.md"

命令格式

ns-md --type pdf|docx --input <markdown路径> [选项]

必填参数：

• --input / -i：Markdown 文件路径（.md）

常用参数：

• --type：pdf（默认）或 docx
• --lang / -l：cn 或 en（默认 cn）
• --output / -o：输出路径（不传则使用默认文件名）

格式专属参数：

• --chromePath：导出 PDF 时指定 Chrome 路径
• --pandoc：导出 DOCX 时指定 Pandoc 可执行文件路径

使用示例

导出 PDF

ns-md --input "D:\docs\spec.md"
ns-md --type pdf --input "D:\docs\spec.md" --lang cn --output "D:\docs\spec-cn.pdf"
ns-md --input "D:\docs\spec.md" --chromePath "C:\Program Files\Google\Chrome\Application\chrome.exe"

导出 DOCX

ns-md --type docx --input "D:\docs\spec.md"
ns-md --type docx --input "D:\docs\spec.md" --lang en --output "D:\docs\spec-en.docx"
ns-md --type docx --input "D:\docs\spec.md" --pandoc "C:\Program Files\Pandoc\pandoc.exe"

运行要求

• Node.js 18+
• PDF：Windows 上可访问的 Chrome（或传入 --chromePath）
• DOCX：已安装 Pandoc 且可在终端执行 pandoc（或传入 --pandoc）

常见问题

1) 提示找不到 pandoc

安装 Pandoc 后，重新打开终端执行 pandoc -v 确认可用；或使用 --pandoc 指定完整路径。

2) 提示找不到 Chrome（PDF 导出）

安装 Chrome 到默认路径，或使用 --chromePath 指定 Chrome 可执行文件路径。

3) 输出文件在哪里

如果未传 --output，工具会按默认规则在输入文件附近生成输出文件。建议在自动化场景中显式传入 --output，便于后续处理。