Tiptap Docs

Install the Pages extension

Available in Team planBeta

Install and configure the Pages extension by following this guide.

Install Pages and its companion packages

The Pages extension does not ship with a node and mark schema. To use it you also install:

  • @tiptap-pro/extension-convert-kit — the canonical editor kit for any Pages or Conversion workflow. ConvertKit registers a DOCX-aware schema (paragraphs, headings, lists, images, marks) that renders both hand-authored content and content imported through Tiptap Conversion.
  • @tiptap-pro/extension-pages-tablekit — pagination-safe tables. Required because ConvertKit's bundled tables are not designed to paginate; using them inside Pages will cause layout to break.

Install all three Pro packages from the private registry:

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

Why ConvertKit and TableKit are separate installs

Neither @tiptap-pro/extension-pages nor @tiptap-pro/extension-pages-pagekit re-exports ConvertKit. They are independent packages that compose together. If you adopt PageKit later, ConvertKit is still a separate install alongside it.

Integrating the Pages extension

Register the three extensions in your editor and disable ConvertKit's table stack so PagesTableKit's TableKit takes over:

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: 'My document',
      footer: 'Page {page} of {total}',
    }),
  ],
})

The pageFormat, header, and footer options are the three you'll touch first. See the API reference for the full list, or Page header and footer for first-page, odd/even, and rich-content header/footer setups.

Authentication

Pages on its own makes no network calls and needs no credentials. The moment you add Tiptap Conversion (DOCX import, PDF export, etc.) on top of Pages, you'll need a JWT and an App ID. See the Conversion install guide for credential setup; the configuration there carries over without modification.

Next steps

PreviouslyOverview