---
title: "Install the Pages extension"
description: "Install the Pages extension in Tiptap to add page-style layout to your editor. Learn more in the docs!"
canonical_url: "https://tiptap.dev/docs/pages/getting-started/install"
---

# Install the Pages extension

Install the Pages extension in Tiptap to add page-style layout to your editor. Learn more in the docs!

Install and configure the Pages extension by following this guide.

- **1. Request access**

  Start a free [trial in your Account](https://cloud.tiptap.dev/v2/billing) or subscribe to a
  [Tiptap plan](https://cloud.tiptap.dev/v2/billing).
- **2. Access the private registry**

  The Pages extension is published in Tiptap's private npm registry. Authenticate to Tiptap's
  private npm registry by following the [setup guide](https://tiptap.dev/docs/guides/pro-extensions.md).
- **3. Install the extension**

  Install the extension from the private registry using npm or your preferred package manager.

## 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:

```bash
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](https://tiptap.dev/docs/pages/guides/pagekit-usage.md) 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:

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

The `pageFormat`, `header`, and `footer` options are the three you'll touch first. See the [API reference](https://tiptap.dev/docs/pages/core-concepts/options.md) for the full list, or [Page header and footer](https://tiptap.dev/docs/pages/core-concepts/page-header-footer.md) 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](https://tiptap.dev/docs/conversion/getting-started/install.md) for credential setup; the configuration there carries over without modification.

## Next steps

- [Pages options](https://tiptap.dev/docs/pages/core-concepts/options.md) — full configuration reference
- [Page header and footer](https://tiptap.dev/docs/pages/core-concepts/page-header-footer.md) — different first page, odd/even pages, and live editing
- [PagesTableKit](https://tiptap.dev/docs/pages/guides/pages-tablekit.md) — pagination-safe tables in detail
- [From zero to print-ready](https://tiptap.dev/docs/pages/guides/zero-to-print-ready.md) — paginated editor with DOCX import and export
- [Limitations](https://tiptap.dev/docs/pages/core-concepts/limitations.md) — what Pages cannot do, including the most important pitfall to avoid