PDF Export
If your readers cannot access the documentation online, then you can provide them with a PDF export of the documentation.
How to export to PDF?
PDFs are exported by version. To export a PDF:
- From the sidebar, choose Version
- Next to the title, click on Settings
- Next to Export to PDF, choose Manage
- In the PDF Exports window, click on Generate New PDF.
Once a PDF export job starts, you can see its progress in the PDF Exports window. When a job is finished, the job will be marked as Done, and you will be able to download the PDF.
PDF Permalink
After you have at least one PDF generated, you can generate a permalink for PDF downloads of the version. The permalink would always download the latest PDF that you have generated. You can use that link publicly if you wish to allow your readers to download the latest PDF.
To get a permalink:
- From the sidebar, choose Version
- Next to the title, click on Settings
- Next to Export to PDF, choose Manage
- In the PDF Exports window, click on Get Permalink
. The URL will be copied to your clipboard.
The permalink is a unique link that cannot be revoked once someone has the link. Make sure you share the permalink with the right audience.
Contents of the PDF
Our exported PDFs contain the following in order:
- A front cover, if you provide it,
- A page containing the project title and version name,
- Table of contents,
- The pages of each documentation,
- The API references,
- A back cover, if you provide it.
Customisation of PDF
PDFs generated by %product% can be customised as follows:
- Add a front cover.
- Add a back cover.
- Add a logo at the top of each page, or a full-size banner.
- Add a full-size banner at the footer of each page.
To customise the PDF, contact us with the customisation assets.
Limitations of PDF
- The PDFs are not interactive: The links in pages do not reference other pages in the PDF.
- Your project must be public.
Troubleshooting Failed Exports
There are specific circumstances when a PDF export might fail. Rest assured that if a PDF export fails, we get notified of it and we can provide you with more information about its failure.
Example of PDF
Download our own PDF from 25th of Aug 2021: