关于 markdown-to-docx
通过 Python 脚本将 Markdown 文件转换为 Microsoft Word DOCX,适用于需要导出单份文档或批量处理文档的用户。支持自定义输出路径,并自动命名和汇总批量转换结果。
主要功能
- 01转换单个 Markdown 文件
- 02批量转换多个文件
- 03自动生成输出文件名
- 04指定文件或目录作为输出位置
- 05检查输入并报告转换结果
适用场景
- 01将 README.md 转为 DOCX
- 02批量导出目录中的 Markdown
- 03为单份文档指定输出名称
- 04将文档集导出到指定目录
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ vace/ markdown-docx --skill markdown-to-docx安装后在 Claude Code 中输入/markdown-to-docx确认已加载。
附带文件scripts/convert_md_to_docx.py
详细介绍
Markdown 转 DOCX 转换器
概览
使用 markdown-docx npm 包将 Markdown 文件转换为 Microsoft Word DOCX 格式。支持单文件和批量转换,并自动命名输出文件。
快速开始
转换单个文件:
python scripts/convert_md_to_docx.py -i document.md
此操作会在同一目录下创建 document.docx。
批量转换:
python scripts/convert_md_to_docx.py -i file1.md file2.md file3.md
每个文件都会在其原始位置转换为 DOCX。
自定义输出位置:
python scripts/convert_md_to_docx.py -i document.md -o output/mydoc.docx
批量转换到指定目录:
python scripts/convert_md_to_docx.py -i *.md -o output_docs/
工作流
当用户请求将 Markdown 转换为 DOCX 时:
- 确定输入文件 - 确认要转换的 Markdown 文件
- 确定输出文件名 - 除非用户指定自定义名称,否则使用自动命名
- 执行转换 - 使用相应参数运行脚本
- 报告结果 - 告知用户转换是否成功以及输出文件的位置
常见用例
转换单个 Markdown 文件
用户:“将 README.md 转换为 DOCX”
python scripts/convert_md_to_docx.py -i README.md
转换当前目录中的所有 Markdown 文件
用户:“将我的所有 Markdown 文件转换为 Word 文档”
python scripts/convert_md_to_docx.py -i *.md
使用自定义输出名称进行转换
用户:“将 notes.md 转换为 report.docx”
python scripts/convert_md_to_docx.py -i notes.md -o report.docx
将一组文档转换到某个文件夹
用户:“将所有文档转换为 DOCX,并放到 exports 文件夹中”
python scripts/convert_md_to_docx.py -i docs/*.md -o exports/
脚本详情
位置: scripts/convert_md_to_docx.py
功能:
- 验证输入文件是否存在且为 Markdown 格式
- 自动生成输出文件名(input.md → input.docx)
- 支持为单个文件指定自定义输出路径
- 支持为批量转换指定输出目录
- 若输出目录不存在,则自动创建
- 提供清晰的成功或失败反馈
- 返回适用于自动化的正确退出码
要求:
- Python 3+
- Node.js 和 npm(用于 npx)
- markdown-docx npm 包(通过 npx 自动获取)
错误处理
脚本会处理常见错误:
- 找不到输入文件 - 报告缺失的文件路径
- 文件类型无效 - 确保输入文件扩展名为 .md 或 .markdown
- npx 不可用 - 检查是否已安装 Node.js/npm
- 转换失败 - 捕获并报告 markdown-docx 错误
提示
- 优先使用自动命名 - 脚本会自动为输出文件命名,减少操作步骤
- 批量操作 - 转换多个文件时,脚本会显示成功与失败的汇总
- 路径处理 - 输入和输出均支持绝对路径和相对路径
- Glob 模式 - 批量操作可以使用 Shell glob 模式(*.md)
评论
支持 Markdown