Export to PDF
Give readers a Download PDF button, add your own header and footer, and design print-ready manuals with a cover page, physical tabs and tag indexes.
How PDF export works
When export is on, Sonat builds a PDF of the document each time you publish, one per language. Readers get a Download PDF button in your help center. You don't export by hand: publishing keeps the PDF up to date.
Turn on PDF export
- In the sidebar, select Addons and install PDF Export. It's free on every plan. See Addons.
- Select Organization Settings and open the Advanced tab.
- Under Document Export, choose Enable Document Export (PDF).
- Select Save.
This is the default for every document. You can change it per document.
Set export for one document
- Open the document and select Document Settings in the sidebar.
- Open the PDF Export tab.
- Under Document Export, choose Use organization settings, Enable or Disable.
- Select Save.

For a topic that isn't in a document, open the topic's Settings, go to Display & export, and set Topic Export.
Add a header and footer
- On the PDF Export tab, find PDF Header & Footer.
- Write the text for PDF Header and PDF Footer.
- Add variables where you want live values:
{{pageNumber}},{{totalPages}},{{documentTitle}}and{{publishDate}}. - Select Save. The next publish uses the new header and footer.
Set page orientation for a topic
Wide tables read better in landscape. Open the topic's Settings, go to Display & export, and choose Portrait or Landscape under Page orientation. It applies to that chapter in the PDF.
Design a custom first page
The default cover shows the document title and description. To design your own, install the Custom PDF First Page addon. It's part of Custom PDF layout: included on Business and Enterprise, and available as an extra on Team.
- On the PDF Export tab, find PDF First Page.
- Choose Rich text to write the cover like a topic, or Canvas to place text, shapes and images freely.
- Design the page and select Save.
Leave it empty to go back to the default cover. The first page never shows the PDF header or footer.
Add physical tabs
Physical tabs turn chosen topics into section dividers for printed binders. They're part of Custom PDF layout and need the Physical Tabs addon.
- Open a topic that starts a section, then its Settings › Display & export.
- Turn on Physical tab (section divider).
- Enter the Tab text to print in the right margin, and pick a Tab color.
- Repeat for each section, then publish.
In the PDF, each tab topic starts on an even page so printed tab cards line up. To show every tab down the edge of every page, turn on Show all tabs on every page under Tab Index On Every Page on the PDF Export tab.
Add a tag index
With the Tags addon, you can add indexes that group topics by tag, such as a list of all procedures.
- On the PDF Export tab, find PDF indexes and select Add index.
- Give it an optional title and pick tags in Select tags for this index.
- Choose what each row shows: Show title, Show tag color, Show updated date.
- Select Save.
Check export history
The Export history table at the bottom of the PDF Export tab lists each PDF Sonat built, with its Status, Language, when it was Queued, Duration, Size and Attempt. Select a finished file to download it.

- If an export failed, read Detail and select Retry.
- If exports are waiting, select Run queue now to start them.
If something goes wrong
Readers don't see Download PDF
Check that export is enabled for the document (or the organization, if the document uses Use organization settings), then publish again. A PDF is only built when you publish.
“No export is waiting — a new PDF is queued each time you publish.”
Run queue now is grayed out because nothing is queued. Publish a topic to queue a new PDF.
PDF First Page or Physical tab is missing
These need Custom PDF layout and their addons, and PDF export must be enabled in Organization Settings › Advanced.
I can't uninstall the PDF Export addon
Sonat keeps the addon while export is enabled anywhere, so you don't lose the settings that turn it off. Disable export for the organization, documents and topics first.