docs: add PDF export documentation to dashboard section #3632
+85
−1
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## PDF export | ||
|
|
||
| You can now export your entire documentation site as a PDF directly from the Fern Dashboard. | ||
|
|
||
| Each export includes: | ||
| - A cover page with a customizable title and subtitle | ||
| - An auto-generated table of contents with clickable links | ||
| - All content pages | ||
| - Optional headers and footers with page number placeholders | ||
|
|
||
| [Learn more](/learn/dashboard/configuration/pdf-export) about PDF exports. To get started, go to **Settings** > **PDF Exporter** in the [Dashboard](https://dashboard.buildwithfern.com/). | ||
|
|
||
| <iframe src="/products/dashboard/assets/cohere-export.pdf" width="100%" height="700px" style={{ border: 'none', borderRadius: '0.5rem' }} /> | ||
|
|
||
| [View the live site](https://docs.cohere.com/) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: PDF export | ||
| description: Export your documentation site as a PDF from the Fern Dashboard. | ||
| --- | ||
|
|
||
| Export your complete documentation site as a PDF directly from the [Fern Dashboard](https://dashboard.buildwithfern.com/). The generated PDF includes a cover page, table of contents with clickable links, and all content pages with headers and footers. | ||
|
|
||
| ## Export your site | ||
|
|
||
| <Steps> | ||
| <Step title="Open the Dashboard"> | ||
|
|
||
| In the [Fern Dashboard](https://dashboard.buildwithfern.com/), navigate to **Settings** > **PDF Exporter** > **Launch**. | ||
| </Step> | ||
|
|
||
| <Step title="Customize export settings"> | ||
|
|
||
| Optionally customize your PDF: | ||
|
|
||
| - **Cover title and subtitle**: Defaults to your Fern Docs site title and subtitle. You can customize or hide these. | ||
| - **Cover footer**: Toggle the "Generated by Fern" footer on the cover page. | ||
| - **Headers and footers**: Add text to the top or bottom of each content page using templates with `{pageIndex}` and `{totalPages}` placeholders. Customize the position (right or left). | ||
| </Step> | ||
|
|
||
| <Step title="Export"> | ||
|
|
||
| Select **Export as PDF** to start the export. Large sites may take a few minutes — you can safely close the page and track progress in the **Exports** section. | ||
|
Contributor
There was a problem hiding this comment. 📝 [vale] reported by reviewdog 🐶 |
||
| </Step> | ||
|
|
||
| <Step title="Download"> | ||
|
|
||
| When the export completes, click **Open** to download the PDF. You can also view past PDF exports. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| <Tabs> | ||
| <Tab title="Cohere"> | ||
| [View the live site](https://docs.cohere.com/) | ||
| <iframe src="../assets/cohere-export.pdf" width="100%" height="700px" style={{ border: 'none', borderRadius: '0.5rem' }} /> | ||
| </Tab> | ||
| <Tab title="Payabli"> | ||
| [View the live site](https://docs.payabli.com/home) | ||
| <iframe src="../assets/payabli-export.pdf" width="100%" height="700px" style={{ border: 'none', borderRadius: '0.5rem' }} /> | ||
| </Tab> | ||
| <Tab title="Fern Docs starter site"> | ||
| [View the live site](https://plantstore.docs.buildwithfern.com/welcome) | ||
| <iframe src="../assets/plantstore-export.pdf" width="100%" height="700px" style={{ border: 'none', borderRadius: '0.5rem' }} /> | ||
| </Tab> | ||
| </Tabs> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated