.png&w=96&q=75)
Documentation
PDF Exporter for ConfluenceBrowse
Documentation
PDF Exporter for ConfluenceFeatures
PDF Exporter for Confluence is a full-featured PDF generation tool built on Atlassian Forge. Here's an overview of everything it can do.
Export Pages
Select individual pages, multi-page hierarchies, or entire spaces. The exporter preserves content structure, images, attachments, and internal link relationships.
Template System
Templates are reusable export profiles. Each template stores a complete set of PDF settings — page layout, fonts, header/footer, cover page, watermark, and more. Apply any template to any export in one click.
Admins create and manage templates from Confluence Settings. Users select from available templates at export time.
Cover Page
Add a title page to your PDF. Choose one of nine ready-made designs, or build your own in the drag-and-drop cover designer — place the title, logo, images and text anywhere on the page.
Table of Contents
Automatically generate a table of contents from the headings in your exported pages. Control how many heading levels to include (1, 2, or 3 levels deep).
Headers & Footers
Add custom text to the top and bottom of every page. Choose the horizontal position (left, center, or right) for both header and footer independently.
Page Numbers
Insert automatic page numbers into the header or footer. Three formats are supported:
1— page number only1 / 10— page X of YPage 1 of 10— verbose format
Watermark
Overlay a text watermark across every page. Set custom watermark text and control its opacity to keep content readable.
Page Breaks
Automatically insert page breaks before H1 or H2 headings to keep sections cleanly separated in the output.
PDF Bookmarks
Embed a navigable bookmark outline (PDF sidebar) in the exported file. Readers can jump directly to any section from their PDF viewer.
Page Setup
Control the physical layout of the output:
- Page size: A4, Letter, Legal
- Orientation: Portrait or Landscape
- Font size: Small, Medium, Large
Merged PDF or ZIP
Export a page tree as one merged PDF — a single document with one table of contents, continuous page numbers and links between pages that keep working — or as a ZIP with a separate PDF for each page.
Background Exports & My Exports
Large exports are generated on Atlassian's servers in the background, so you can close the page while they run. Finished files wait in My exports. Small exports still build instantly in your browser, and Auto picks for you. Server exports run one at a time per site, and each site can render 10,000 pages a month on the server.
→ Background Exports & My Exports
Scheduled Exports
Export a space or page tree every week or month. Each run attaches a dated PDF to an archive page (or saves it to My exports) and can email people through a Confluence @mention, replying in one comment thread per schedule.
REST API
Start exports from scripts and CI/CD pipelines with an API token: export a page, page tree or space, attach the file to a page and notify people.
→ REST API
Usage Statistics
The Usage tab on the admin page shows exports and pages per day over 30 days, 90 days or 12 months, which outputs people choose and where exports start. Only counts are kept — no user or page names.
Live Preview
Preview the generated PDF before downloading to verify the output looks correct.
Guides for PDF Exporter for Confluence
Stuck on something this page does not cover? Ask the developers.