---
title: "安装 Pages 扩展"
description: "在 Tiptap 中安装 Pages 扩展，为你的编辑器添加页面式布局。在文档中了解更多！"
canonical_url: "https://tiptap.zhcndoc.com/pages/getting-started/install"
---

# 安装 Pages 扩展

在 Tiptap 中安装 Pages 扩展，为你的编辑器添加页面式布局。在文档中了解更多！

按照本指南安装并配置 Pages 扩展。

- **1. 申请访问权限**

  开始在您的[账户中免费试用](https://cloud.tiptap.dev/v2/billing)，或订阅
  [Tiptap 计划](https://cloud.tiptap.dev/v2/billing)。
- **2. 访问私有注册表**

  Pages 扩展发布在 Tiptap 的私有 npm 注册表中。请按照[设置指南](https://tiptap.zhcndoc.com/guides/pro-extensions.md)完成对 Tiptap 私有 npm 注册表的身份验证。
- **3. 安装扩展**

  使用 npm 或您偏好的包管理工具从私有注册表安装该扩展。

## 安装 Pages 及其配套包

Pages 扩展**不**自带 node 和 mark schema。要使用它，您还需要安装：

- **`@tiptap-pro/extension-convert-kit`**：适用于任何 Pages 或 Conversion 工作流的标准编辑器套件。ConvertKit 注册了一个支持 DOCX 的 schema（段落、标题、列表、图片、marks），可同时渲染手动编写的内容以及通过 Tiptap Conversion 导入的内容。
- **`@tiptap-pro/extension-pages-tablekit`**：支持分页安全的表格。之所以需要它，是因为 ConvertKit 自带的表格并不适合分页；在 Pages 中使用它们会导致布局错乱。

请从私有注册表安装这三个 Pro 包：

```bash
npm install @tiptap-pro/extension-convert-kit \
            @tiptap-pro/extension-pages-tablekit \
            @tiptap-pro/extension-pages
```

> **为什么 ConvertKit 和 TableKit 是分开安装的:**
>
> `@tiptap-pro/extension-pages` 和 `@tiptap-pro/extension-pages-pagekit` 都不会重新导出
> ConvertKit。它们是可以组合在一起的独立包。如果您之后采用
> [PageKit](https://tiptap.zhcndoc.com/pages/guides/pagekit-usage.md)，ConvertKit 仍然需要作为单独的安装项与之一起使用。

## 集成 Pages 扩展

在编辑器中注册这三个扩展，并禁用 ConvertKit 的表格栈，让 PagesTableKit 的 `TableKit` 接管：

```ts
import { Editor } from '@tiptap/core'
import { ConvertKit } from '@tiptap-pro/extension-convert-kit'
import { TableKit } from '@tiptap-pro/extension-pages-tablekit'
import { Pages } from '@tiptap-pro/extension-pages'

const editor = new Editor({
  extensions: [
    ConvertKit.configure({ table: false }),
    TableKit,
    Pages.configure({
      pageFormat: 'A4',
      header: '我的文档',
      footer: '第 {page} 页，共 {total} 页',
    }),
  ],
})
```

`pageFormat`、`header` 和 `footer` 这三个选项是您最先会接触到的。完整列表请参见 [API 参考](https://tiptap.zhcndoc.com/pages/core-concepts/options.md)，或者查看[页面页眉和页脚](https://tiptap.zhcndoc.com/pages/core-concepts/page-header-footer.md)，了解首页、奇偶页以及富内容页眉/页脚的设置方式。

## 身份验证

Pages 本身不会进行任何网络调用，也不需要任何凭据。一旦你在 Pages 之上添加 Tiptap Conversion（DOCX 导入、PDF 导出等），就需要一个签名令牌。有关设置，请参阅 [Conversion 安装指南](https://tiptap.zhcndoc.com/conversion/getting-started/install.md)。那里的配置可以直接沿用，无需修改。

## 后续步骤

- [Pages 选项](https://tiptap.zhcndoc.com/pages/core-concepts/options.md)：完整配置参考
- [页面页眉和页脚](https://tiptap.zhcndoc.com/pages/core-concepts/page-header-footer.md)：首页不同、奇偶页不同，以及实时编辑
- [PagesTableKit](https://tiptap.zhcndoc.com/pages/guides/pages-tablekit.md)：详细介绍分页安全表格
- [从零到可打印](https://tiptap.zhcndoc.com/pages/guides/zero-to-print-ready.md)：支持 DOCX 导入和导出的分页编辑器
- [限制](https://tiptap.zhcndoc.com/pages/core-concepts/limitations.md)：Pages 不能做什么，包括最重要的要避免的陷阱