Export EPUB from your editor

Use Tiptap's @tiptap-pro/extension-export-epub to export your editor's content as an .epub file. This extension integrates EPUB export functionality into your editor by sending the document to the Tiptap convert service for conversion.

You can also use the REST API instead if you'd prefer to handle the conversion on your end.

Install the EPUB Export extension

The Conversion extensions are published in Tiptap's private npm registry. Integrate the extensions by following the private registry guide.

Once done you can install and import the Export EPUB extension package.

npm i @tiptap-pro/extension-export-epub

import { ExportEpub } from '@tiptap-pro/extension-export-epub'

Configuring the extension

The ExportEpub extension can be configured with an ExportEpubOptions (object) as an argument to the configure method with the following properties:

import { ExportEpub } from '@tiptap-pro/extension-export-epub'

const editor = new Editor({
  extensions: [
    // Other extensions ...
    ExportEpub.configure({
      endpoint: 'https://api.tiptap.dev/v2/convert',
      token: 'YOUR_TOKEN',
      appId: 'YOUR_APP_ID',
      styleOverrides: {},
      headers: {},
      footers: {},
      pageSize: { width: '21cm', height: '29.7cm' },
      pageMargins: { top: '1cm', bottom: '1cm', left: '1cm', right: '1cm' },
      customNodes: [],
      onCompleteExport: (result) => {
        // Handle the exported Blob
      },
    }),
    // Other extensions ...
  ],
})

HeaderConfig

FooterConfig

PageSize

PageMargins

Export an EPUB file

With the extension installed, you can export your editor's content to .epub using the exportEpub command.

/**
 * Export the current document as an EPUB file via the Tiptap convert service.
 *
 * @param options - All extension-level options can be overridden per-invocation
 * @example editor.commands.exportEpub({ onCompleteExport: (result) => {} })
 */
exportEpub: (options?: ExportEpubCommandOptions) => ReturnType

The ExportEpubCommandOptions interface extends ExportEpubOptions, so every configuration option can be overridden per-command invocation:

import { ExportEpub } from '@tiptap-pro/extension-export-epub'

const editor = new Editor({
  extensions: [
    // Other extensions ...
    ExportEpub.configure({
      token: 'YOUR_TOKEN',
      appId: 'YOUR_APP_ID',
      onCompleteExport(result) {
        // Download the EPUB file
        const url = URL.createObjectURL(result)
        const a = document.createElement('a')

        a.href = url
        a.download = 'document.epub'
        a.click()

        URL.revokeObjectURL(url)
      },
    }),
    // Other extensions ...
  ],
})

// Use the extension-level callback
editor.chain().exportEpub().run()

// Or override options for a specific export
editor
  .chain()
  .exportEpub({
    pageSize: { width: '8.5in', height: '11in' },
    onCompleteExport(result) {
      // Custom handling for this specific export
      const url = URL.createObjectURL(result)
      window.open(url)
    },
  })
  .run()

How it works

When you call exportEpub, the extension sends the editor's document and any configured options (style overrides, page layout, headers, footers) to the Convert service, which returns the resulting .epub file as a binary blob. The onCompleteExport callback receives the blob directly. Errors are thrown as exceptions rather than passed through the callback.

What to expect

• Authentication required (token JWT and appId). Generate JWTs server-side. See the Conversion install guide.
• HTTP responses to handle: 401 (missing or invalid JWT), 403 (operation not permitted for your app — typically a format your plan doesn't include), 5xx (transient server-side error; retry with backoff).
• Each request is processed end-to-end before responding. Plan for longer round-trips on long documents.

What not to expect

• Per-chapter metadata customisation. EPUB metadata (book title, author, language, custom chapter spine) is not yet configurable through the export options.
• Pixel-perfect rendering across reading apps. EPUB rendering is reading-app-dependent; spacing, font fallback, and image scaling vary across apps and devices. Test against the readers your audience uses.

Support & Limitations

For a detailed per-feature breakdown, see the Supported features matrix. Note that element overrides (paragraphOverrides, textRunOverrides, tableOverrides, tableCellOverrides, imageOverrides) available in the DOCX export extension are not passed through to the EPUB conversion.