mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Leyland Yang
8b337fabd8
* Document contextual PDF download option * Tighten contextual PDF docs update * Remove contextual docs formatting change * add enterprise gate * add link in pdf-exports page * Update pdf-exports.mdx --------- Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
44 lines
1.9 KiB
Plaintext
44 lines
1.9 KiB
Plaintext
---
|
|
title: "PDF exports"
|
|
description: "Export your entire documentation site as a single PDF with a navigable table of contents for offline reading, sharing, and print distribution."
|
|
keywords: ["PDF", "offline docs"]
|
|
---
|
|
|
|
export const DownloadPDFButton = () => {
|
|
return (
|
|
<a download="mintlify-example.pdf" href="/files/mint-full-docs.pdf" className="border border-zinc-200 dark:border-zinc-800 hover:bg-zinc-100 dark:hover:bg-zinc-700 transition-colors w-fit text-sm font-medium flex items-center gap-2 rounded-lg px-3.5 py-1.5 not-prose">
|
|
<Icon icon="download" size={16} />
|
|
View Example PDF
|
|
</a>
|
|
)
|
|
}
|
|
|
|
<Info>
|
|
PDF exports are available on [Enterprise plans](https://mintlify.com/pricing).
|
|
</Info>
|
|
|
|
You can export your docs as a single PDF file for offline viewing. The PDF contains all the content in the docs, including images and links, and a navigable table of contents.
|
|
|
|
PDF exports are not supported for documentation sites that use authentication.
|
|
|
|
<Tip>
|
|
To let users download individual pages as PDFs, use the [contextual menu's](/ai/contextual-menu) `download-pdf` option instead.
|
|
</Tip>
|
|
|
|
## Export a PDF
|
|
|
|
1. Navigate to the [General](https://app.mintlify.com/settings/deployment/general) page in the Project Settings section of your dashboard.
|
|
2. Click the **Export all content** button.
|
|
3. Optionally, customize the export options:
|
|
- **Page format**: Choose the page size of the PDF.
|
|
- **Scale percentage**: Adjust the scale of the PDF.
|
|
- **Include footer**: Include a footer with the page number and total pages.
|
|
- **Language**: If your content is available in multiple languages, choose which language to export.
|
|
4. Click **Export** to start the export process.
|
|
5. Once the export is complete, you receive an email with a download link.
|
|
6. Click the download link to download the PDF file.
|
|
|
|
|
|
<DownloadPDFButton />
|
|
|