python-docx-creator
使用 python-docx 库将 Markdown 或纯文本内容转换为格式化的 Word 文档。
快速开始
核心脚本
使用 scripts/create_docx.py 生成 Word 文档:
# 从文本创建
python3 scripts/create_docx.py --title "标题" --text "# 内容\n\n段落文本" --output output.docx
# 从文件创建
python3 scripts/create_docx.py --title "标题" --input input.md --output output.docx
功能特性
支持的 Markdown 格式
- 标题:
# H1、## H2、### H3 - 无序列表:
- 项目或* 项目 - 有序列表:
1. 项目、2. 项目 - 粗体:
**粗体文本**或__粗体文本__ - 斜体:
*斜体文本*或_斜体文本_ - 普通段落:自动识别并添加
脚本参数
| 参数 | 说明 | 必填 |
|---|---|---|
--title |
文档标题 | 否 |
--input |
输入的 Markdown 文件路径 | 否* |
--text |
直接输入的文本内容 | 否* |
--output |
输出的 Word 文档路径 | 是 |
*注:--input 和 --text 至少提供一个
使用流程
1. 检查依赖
python3 -c "import docx; print('python-docx installed')" 2>&1 || echo "NOT_INSTALLED"
如果未安装,运行:
pip install python-docx
2. 准备内容
选项 A:从文件读取
# 文档标题
## 章节一
这是第一段内容。
- 列表项1
- 列表项2
**重点内容** 和 *强调内容*
选项 B:直接使用文本
在命令行中传递 Markdown 格式的文本内容。
3. 生成文档
# 示例:生成知识库说明文档
python3 scripts/create_docx.py \
--title "什么是知识库?" \
--text "# 什么是知识库?\n\n知识库是结构化存储、组织和检索知识的系统...\n\n## 从产品视角看\n\n1. 企业知识库\n2. AI 知识库" \
--output /Users/apple/Desktop/输出文档.docx
4. 验证输出
ls -lh <output-file>.docx
常见使用场景
场景1:将回答保存为 Word 文档
当用户要求"把输出结果转换为 Word 文档并保存"时:
- 提取需要保存的回答内容
- 格式化为 Markdown
- 调用
create_docx.py生成 .docx 文件 - 保存到用户指定路径(如桌面)
场景2:批量生成文档
# 循环生成多个文档
for file in *.md; do
python3 scripts/create_docx.py \
--input "$file" \
--output "${file%.md}.docx"
done
注意事项
- 编码:脚本使用 UTF-8 编码,支持中文内容
- 格式限制:当前版本不支持表格、图片、页眉页脚等高级格式
- 路径:输出路径需要用户有写权限
扩展方向
如需支持更多 Word 格式(表格、图片、样式等),可以扩展 create_docx.py:
- 添加表格支持:使用
doc.add_table() - 添加图片支持:使用
doc.add_picture() - 添加样式定制:修改
doc.styles
参考资料
- python-docx 官方文档:https://python-docx.readthedocs.io/
- Markdown 语法参考:https://www.markdownguide.org/basic-syntax/