快速开始

安装

如何安装 office-open 包

统一包

当你需要多种文档类型、CLI 支持或 AI 集成时,安装 office-open 统一包:

pnpm add office-open

统一包导出所有文档生成包,并提供 CLI、Zod schemas 和 AI SDK 工具。

独立包

也可以只安装你需要的特定包:

pnpm add @office-open/docx
pnpm add @office-open/pptx
pnpm add @office-open/xlsx

共享依赖(@office-open/core@office-open/xml)会自动引入。

浏览器

在浏览器中使用时,直接从支持 ESM 的 CDN 导入:

<script type="module">
  import { generateDocument } from "https://esm.sh/@office-open/docx";

  // ... 创建并导出你的文档
</script>

或使用打包工具(Vite、Webpack 等)——这些包以标准 ESM 模块发布,开箱即用。

TypeScript

所有包均使用 TypeScript 编写,附带完整的类型定义,提供全面的自动补全和类型安全。

import { generateDocument } from "@office-open/docx";

// 完整的类型支持和自动补全
const buffer = await generateDocument({
  sections: [
    {
      children: [{ children: [{ text: "Hello, World!", bold: true }] }],
    },
  ],
});

环境要求

  • Node.js >= 18
  • TypeScript >= 5.0(可选,但推荐)
Copyright © 2026