.png&w=96&q=75)
Documentation
PDF Exporter for ConfluenceBrowse
Documentation
PDF Exporter for ConfluenceGetting Started
Export Confluence pages to professionally formatted PDFs in just a few steps.
Overview
PDF Exporter for Confluence turns any Confluence page, page tree or whole space into a polished PDF. Pick a template, and the export gets your cover page, headers, footers, watermark and table of contents.
What You Can Do
| Feature | What it does |
|---|---|
| Export pages and spaces | Export one page, a page and everything under it, or a whole space |
| One merged PDF or a ZIP | One document with a single table of contents and continuous page numbers, or a separate PDF for each page |
| Templates | Reusable styles for page setup, fonts, headers, footers and watermarks |
| Cover designer | Ready-made cover designs, or drag the title, logo, images and text anywhere on the cover |
| Background exports and My exports | Large exports run on Atlassian's servers while you do something else, and wait for you in My exports |
| Scheduled exports | Export a space or page tree every week or month, attach each file to an archive page and email people |
| REST API | Start exports from scripts and CI/CD pipelines with an API token |
Prerequisites
- Atlassian Confluence Cloud instance
- PDF Exporter for Confluence installed from the Atlassian Marketplace
- View permission on the pages you want to export
Step 1: Install the App
Install PDF Exporter for Confluence from the Atlassian Marketplace. See the Installation Guide for step-by-step instructions.
Step 2: Open the Exporter
To export the page you're on, click Export to PDF under the page title. A page without child pages opens a live preview of the PDF; a page with children opens the full exporter.
To export several pages, a page tree or a space:
- Open any Confluence page
- Click the ··· (More actions) menu in the top-right toolbar
- Select PDF Exporter for Confluence
You can also open the full exporter from Apps → PDF Exporter for Confluence in the Confluence navigation. That's also where you find My exports and Schedules.
Step 3: Select Pages
Use the hierarchical page tree to select the pages you want to export:
- Check a single page to export just that page
- Check a parent page to include it and all its children
- Use the search bar to quickly find pages across the space
Step 4: Choose a Template
Select a template from the sidebar dropdown. Templates define the visual style of your exported PDF — font size, header/footer, cover page, watermark, and more.
Three default templates are available out of the box:
| Template | Description |
|---|---|
| Default | Clean export with page numbers, no cover page |
| Report | Cover page, table of contents, page breaks before H1 sections |
| Minimal | No header, footer, or page numbers — pure content |
Admins can create additional custom templates. See Template Management.
Step 5: Export
Click Export. For multi-page exports, choose One merged PDF for a single document or Separate PDFs (ZIP) for one file per page.
Small exports are built in your browser and download straight away. Large ones are built on the server in the background: a Preparing Export card appears while the app checks the pages and your access, then a progress card follows the export. You can close the page and download the file later from My exports. See Background Exports & My Exports.
For Admins: Approve the Latest Update
Scheduled exports, the REST API and attaching exports to pages arrived in a major version that asks for new permissions. Until a Confluence admin approves it, those features stay off; exporting keeps working. Admins see an Update required notice in Confluence Settings → PDF Exporter, and users see a notice in the exporter.
To approve it, go to Settings → Manage apps, find PDF Exporter for Confluence and select Update. On some sites the request is under admin.atlassian.com → Apps → Connected apps.
| New permission | What the app uses it for |
|---|---|
read:confluence-user |
Show the names of schedule and token owners, and fill in {lastEditedBy} in server exports |
write:attachment:confluence |
Attach scheduled and API exports to the archive page you choose |
read:content-details:confluence |
Required by Confluence, together with the attachment permission, to upload a file to a page |
write:comment:confluence |
Post the comment that @mentions people about a run, so Confluence emails them |
See Pricing & Permissions for every permission the app uses.
What's Next?
- Export Pages & Spaces
- Cover Page Customization
- Table of Contents
- Manage Templates
- Background Exports & My Exports
- Scheduled Exports
- REST API
Need Help?
Guides for PDF Exporter for Confluence
Stuck on something this page does not cover? Ask the developers.