这个项目能做什么

docx 是一个开源的 JavaScript/TypeScript 库,用于创建和修改 .docx(Microsoft Word)文档。其 README 展示了声明式 API:你通过 Document、Paragraph、Header 和 Table 等对象描述文档结构,该库便会生成 .docx 文件。据称它既能在 Node 中运行,也能在浏览器中运行。 文档和示例位于 docx.js.org,仓库中还包含一个 demo 文件夹。README 链接到了 CodePen 和 JSFiddle 上的浏览器演示,StackBlitz 上的 Angular、React 和 Vue.js 框架示例,以及 RunKit 上的 Node 示例,涵盖了简单和高级段落、项目符号、表格、图像、页边距、横向打印和页眉页脚。其中一个示例被描述为使用 docx 生成的简历。 除了核心包之外,README 还记录了可选的入口点:用于形状、形状组和带连接符图表的 docx/shapes;用于水印的 docx/watermarks;以及用于原生 Word 图表的 docx/charts。这些内容被排除在主包之外,因此不使用它们的文档不会携带其代码。一段代码示例展示了如何导入 ChartRun、ShapeRun 和 TextWatermark,并在包含节、页眉和段落的 Document 中使用它们。对于没有打包器的页面,README 指出应在 dist/index.umd.cjs 之后加载 dist/shapes.umd.cjs、dist/watermarks.umd.cjs 或 dist/charts.umd.cjs,这会添加 docxShapes、docxWatermarks 和 docxCharts 全局变量。 README 还指向了 Docx.js Editor(一个用于编码和实时预览结果的交互式演练场)以及贡献指南。它列出了许多使用该库的公司和产品,并包含了 npm 版本、每月下载量、GitHub Actions 工作流状态、已知漏洞、欢迎拉取请求状态和代码覆盖率的徽章。该项目通过 npm 以包名 docx 分发。