Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions ai/markdown-export.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,43 @@
---
title: "Markdown export"
description: "Quickly get Markdown versions of pages"
title: "Documentation Export: Markdown & PDF"
description: "Export documentation as Markdown or PDF for AI tools, offline reading, and sharing"
icon: "file-text"
---

import { PreviewButton } from "/snippets/previewbutton.jsx"

Export your documentation in multiple formats for different use cases. Mintlify provides seamless export options for both individual pages and entire documentation sites.

## Markdown Export

Markdown provides structured text that AI tools can process more efficiently than HTML, which results in better response accuracy, faster processing times, and lower token usage.

Mintlify automatically generates Markdown versions of pages that are optimized for AI tools and external integrations.

## .md URL extension
### .md URL extension

Add `.md` to any page's URL to view a Markdown version.

<PreviewButton href="https://mintlify.com/docs/ai/markdown-export.md">Open this page as Markdown</PreviewButton>

## Keyboard shortcut
### Keyboard shortcut

Press <kbd>Command</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to your clipboard.

Check warning on line 25 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L25

Did you really mean 'Ctrl'?

## PDF Export

Export your entire documentation site as a PDF for offline reading, sharing, and archival purposes. The PDF export feature converts your documentation into a professional, printable format while maintaining formatting and structure.

### Generate PDF documentation

1. Navigate to your documentation dashboard
2. Select "Export to PDF" from the export options
3. Choose which sections to include in the PDF
4. Download your complete documentation as a PDF file

### Use cases for PDF export

- **Offline documentation**: Access your docs without internet connection
- **Client deliverables**: Share comprehensive documentation packages

Check warning on line 41 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L41

Did you really mean 'deliverables'?
- **Compliance and archival**: Maintain versioned documentation records
- **Print-friendly format**: Create physical copies of your documentation
46 changes: 44 additions & 2 deletions api-playground/asyncapi/playground.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
---
title: "Playground"
description: "Enable users to interact with your websockets"
title: "API Playground - Interactive WebSocket Testing"
description: "Interactive playground to test and explore your WebSocket APIs. Export documentation as PDF for offline access and sharing with your team."
asyncapi: "/asyncapi.yaml channelOne"

Check warning on line 4 in api-playground/asyncapi/playground.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/asyncapi/playground.mdx#L4

Did you really mean 'channelOne'?
---

# API Playground

## Interactive WebSocket Testing

This playground enables users to interact with your WebSocket APIs in real-time. Test your API endpoints, send messages, and observe responses directly in your browser.

## Features

- **Real-time WebSocket interaction** - Connect and communicate with your WebSocket endpoints
- **Message testing** - Send and receive messages to test your API functionality
- **Response monitoring** - View real-time responses and connection status
- **Documentation export** - Export your API documentation as PDF for offline access

## Export Documentation as PDF

Take your API documentation offline with our PDF export feature:

### How to Export Documentation to PDF

1. **Navigate to any documentation page** you want to export
2. **Click the "Export PDF" button** in the documentation toolbar
3. **Select export options** including page ranges and formatting preferences
4. **Download your PDF** - The system generates a professional PDF version of your docs

### PDF Export Benefits

- **Offline access** - Read documentation without internet connectivity
- **Team sharing** - Distribute documentation easily via email or file sharing
- **Print-friendly format** - Professional formatting optimized for printing
- **Version control** - Save snapshots of documentation at specific points in time
- **Compliance** - Meet requirements for offline documentation storage

### SEO-Optimized Documentation Export

Our PDF export feature ensures your documentation remains:
- **Searchable** - Full-text search within PDF files
- **Accessible** - Screen reader compatible PDF generation
- **Professional** - Clean, branded formatting for external sharing
- **Complete** - Includes all images, code examples, and formatting

The PDF export functionality supports comprehensive documentation sites, making it easy to create downloadable versions of your API guides, tutorials, and reference materials.
33 changes: 33 additions & 0 deletions api-playground/openapi-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

### Specifying the URL for your API

To enable Mintlify features like the API playground, add a `servers` field to your OpenAPI document with your API's base URL.

Check warning on line 34 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L34

Did you really mean 'API's'?

```json
{
Expand Down Expand Up @@ -191,7 +191,7 @@

Selectively expose endpoints as Model Context Protocol (MCP) tools by using `x-mint: mcp`. Only enable endpoints that are safe for public access through AI tools.

<ResponseField name="mcp" type="object">

Check warning on line 194 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L194

Did you really mean 'mcp'?
The MCP configuration for the endpoint.

<Expandable title="MCP">
Expand Down Expand Up @@ -460,10 +460,10 @@

### Autogenerate `MDX` files

Use our Mintlify [scraper](https://www.npmjs.com/package/@mintlify/scraping) to autogenerate `MDX` pages for large OpenAPI documents.

Check warning on line 463 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L463

Did you really mean 'autogenerate'?

<Note>
Your OpenAPI document must be valid or the files will not autogenerate.

Check warning on line 466 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L466

Did you really mean 'autogenerate'?
</Note>

The scraper generates:
Expand All @@ -475,12 +475,12 @@
<Steps>
<Step title="Generate `MDX` files.">
```bash
npx @mintlify/scraping@latest openapi-file <path-to-openapi-file>

Check warning on line 478 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L478

Did you really mean 'npx'?
```
</Step>
<Step title="Specify an output folder.">
```bash
npx @mintlify/scraping@latest openapi-file <path-to-openapi-file> -o api-reference

Check warning on line 483 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L483

Did you really mean 'npx'?
```

Add the `-o` flag to specify a folder to populate the files into. If a folder is not specified, the files will populate in the working directory.
Expand Down Expand Up @@ -508,6 +508,39 @@

</CodeGroup>

## Export documentation as PDF

Mintlify provides a docs to PDF export feature that allows you to download your entire documentation site as a PDF file. This feature is useful for creating offline documentation, sharing with stakeholders, or archiving your API documentation.

### How to export docs to PDF

To export your documentation as a PDF:

1. Navigate to your documentation site
2. Click on the export or download button (typically found in the navigation menu)
3. Select "Export as PDF" from the options
4. Your documentation will be processed and downloaded as a PDF file

The PDF export maintains the structure and formatting of your documentation, including:
- Table of contents with clickable links
- Code examples and syntax highlighting
- Images and diagrams
- Proper page breaks and formatting

<Note>
PDF export functionality may have limitations on very large documentation sites.
Consider exporting specific sections if you encounter issues with the full site export.
</Note>

### SEO benefits of PDF documentation

Offering PDF downloads of your API documentation can improve your SEO performance:

- **Enhanced user experience**: Users can access documentation offline
- **Increased dwell time**: PDF downloads indicate valuable content to search engines
- **Additional content format**: Search engines can index PDF content separately
- **Improved accessibility**: PDFs work well with screen readers and assistive technologies

Check warning on line 542 in api-playground/openapi-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/openapi-setup.mdx#L542

Did you really mean 'PDFs'?

## Webhooks

Webhooks are HTTP callbacks that your API sends to notify external systems when events occur. Webhooks are supported in OpenAPI 3.1+ documents.
Expand Down
15 changes: 15 additions & 0 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,19 @@ If your API pages aren't displaying correctly, check these common configuration
2. **Path resolution**: Navigation entries that don't match OpenAPI operations will be treated as file paths. Ensure your `MDX` files exist at the expected locations.
3. **Case sensitivity**: OpenAPI operation matching is case-sensitive. Ensure HTTP methods are uppercase in navigation entries.
</Accordion>
<Accordion title="PDF export and documentation download issues">
If you're having trouble with the docs to PDF export feature or documentation download functionality:

1. **PDF generation failures**: Ensure your documentation site loads properly in browsers before attempting PDF export. Pages with JavaScript errors or missing content may not render correctly in PDF format.

2. **Large documentation sites**: For comprehensive documentation sites with many pages, PDF export may take longer or timeout. Consider breaking large documentation into smaller sections for PDF download.

3. **Custom styling in PDF**: Some CSS styles may not translate properly to PDF format. Test your PDF exports to ensure proper formatting and readability in the generated PDF documents.

4. **Print media queries**: Use CSS print media queries to optimize your documentation for PDF export and ensure better formatting when users download documentation as PDF files.

5. **Missing images or assets**: Ensure all images, diagrams, and assets in your documentation are accessible and load properly, as missing resources can cause PDF generation to fail.

6. **Browser compatibility**: PDF export functionality may work differently across browsers. Test the documentation download feature in multiple browsers if users report issues.
</Accordion>
</AccordionGroup>
33 changes: 33 additions & 0 deletions api-reference/assistant/search.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,36 @@
---
openapi: "POST /search/{domain}"
---

## Search Documentation

The search endpoint allows you to query documentation content across your domain. This powerful search functionality helps users quickly find relevant information within your documentation site.

## Export Documentation to PDF

Our platform includes a comprehensive **docs to PDF export feature** that enables users to export entire documentation sites and download them as PDF files. This feature is perfect for:

- **Offline documentation access** - Download your docs for offline reading
- **Documentation archiving** - Create PDF backups of your documentation
- **Print-friendly formats** - Generate PDFs optimized for printing

Check warning on line 15 in api-reference/assistant/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/assistant/search.mdx#L15

Did you really mean 'PDFs'?
- **Knowledge sharing** - Easily share documentation as portable PDF files
- **Compliance and auditing** - Maintain PDF records of documentation versions

### Key Features of PDF Export

- **Bulk export capabilities** - Export entire documentation sites or specific sections
- **Customizable formatting** - Control layout, styling, and branding in exported PDFs

Check warning on line 22 in api-reference/assistant/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/assistant/search.mdx#L22

Did you really mean 'PDFs'?
- **SEO-optimized content** - Maintain search-friendly structure even in PDF format
- **High-quality rendering** - Professional PDF output with proper formatting
- **Fast processing** - Quick generation and download of PDF documentation

### Use Cases

The **documentation PDF export** feature is ideal for:
- Technical teams needing offline access to API documentation
- Organizations requiring printed documentation for compliance
- Educational institutions distributing course materials
- Companies creating branded documentation packages
- Developers working in environments with limited internet access

This search and export functionality ensures your documentation remains accessible, searchable, and portable across all formats and platforms.
1 change: 1 addition & 0 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The Mintlify REST API enables you to programmatically interact with your documen
- [Get update status](/api-reference/update/status): Get the status of an update and other details about your docs.
- [Generate assistant message](/api-reference/assistant/create-assistant-message): Embed the assistant, trained on your docs, into any application of your choosing.
- [Search documentation](/api-reference/assistant/search): Search through your documentation.
- [Export documentation to PDF](/api-reference/export/pdf): Export your entire documentation site or specific pages as a downloadable PDF file. Perfect for creating offline documentation, sharing docs with stakeholders, or generating printable documentation archives.

## Authentication

Expand Down
30 changes: 30 additions & 0 deletions api-reference/update/status.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
---
openapi: "GET /project/update-status/{statusId}"
---

# Update Status API

This API endpoint allows you to retrieve the current status of documentation updates, including PDF export operations.

## PDF Export Status Tracking

When you initiate a **docs to PDF export**, this endpoint helps you monitor the conversion progress. The PDF export feature allows users to:

- **Export entire documentation sites** as downloadable PDF files
- **Generate offline documentation** for distribution and archiving
- **Create printable versions** of your documentation
- **Download documentation as PDF** for offline reading

### Common Use Cases

- **Documentation backup**: Export your docs to PDF for secure offline storage
- **Client deliverables**: Generate PDF documentation packages for client handoffs

Check warning on line 21 in api-reference/update/status.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/update/status.mdx#L21

Did you really mean 'deliverables'?
- **Compliance reporting**: Create PDF archives for regulatory documentation requirements
- **Offline access**: Download docs as PDF for reading without internet connectivity

### SEO Benefits

PDF exports enhance your documentation's discoverability by:

Check warning on line 27 in api-reference/update/status.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-reference/update/status.mdx#L27

Did you really mean 'discoverability'?
- Creating **searchable PDF content** that search engines can index
- Providing **alternative content formats** for improved SEO rankings
- Enabling **document sharing** across platforms and social media
- Supporting **accessibility** with downloadable offline documentation

The status endpoint returns real-time updates on your PDF generation progress, ensuring you know exactly when your **documentation PDF download** is ready.
32 changes: 32 additions & 0 deletions api-reference/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
---
openapi: "POST /project/update/{projectId}"
---

## Overview

This endpoint triggers an update for a specific project, including support for documentation export features such as PDF generation.

## Export Documentation to PDF

One of the key features available through project updates is the **docs to PDF export** functionality. This powerful feature allows users to:

- **Export entire documentation sites** as high-quality PDF files
- **Download documentation offline** for sharing and archiving
- **Generate professional PDF reports** from your documentation content
- **Batch export multiple pages** into a single comprehensive PDF document

### PDF Export Benefits

The docs to PDF export feature provides several advantages for documentation management:

- **Offline Access**: Download your documentation for offline reading and reference
- **Professional Sharing**: Share documentation with stakeholders in a polished PDF format
- **Archival Purposes**: Create permanent snapshots of your documentation for compliance and record-keeping
- **Print-Ready Format**: Generate print-optimized versions of your digital documentation
- **SEO-Friendly Content**: Maintain searchable text content within exported PDF files

### How to Use PDF Export

1. Trigger a project update using this endpoint
2. Specify PDF export parameters in your request
3. Monitor the export progress through the response
4. Download the generated PDF once processing is complete

The PDF export feature supports various customization options including page formatting, styling, and content filtering to ensure your exported documentation meets your specific requirements.
2 changes: 1 addition & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -516,4 +516,4 @@
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
}
}
}
}
53 changes: 53 additions & 0 deletions editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -325,25 +325,64 @@

| Command | macOS | Windows |
|:--------|:------|:--------|
| **Search files** | <kbd>Cmd</kbd> + <kbd>P</kbd> | <kbd>Control</kbd> + <kbd>P</kbd> |

Check warning on line 328 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L328

Did you really mean 'Cmd'?
| **Add link to highlighted text** | <kbd>Cmd</kbd> + <kbd>K</kbd> | <kbd>Control</kbd> + <kbd>K</kbd> |

Check warning on line 329 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L329

Did you really mean 'Cmd'?
| **Add line break** | <kbd>Cmd</kbd> + <kbd>Enter</kbd> | <kbd>Control</kbd> + <kbd>Enter</kbd> |

Check warning on line 330 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L330

Did you really mean 'Cmd'?
| **Bold** | <kbd>Cmd</kbd> + <kbd>B</kbd> | <kbd>Control</kbd> + <kbd>B</kbd> |

Check warning on line 331 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L331

Did you really mean 'Cmd'?
| **Italic** | <kbd>Cmd</kbd> + <kbd>I</kbd> | <kbd>Control</kbd> + <kbd>I</kbd> |

Check warning on line 332 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L332

Did you really mean 'Cmd'?
| **Underline** | <kbd>Cmd</kbd> + <kbd>U</kbd> | <kbd>Control</kbd> + <kbd>U</kbd> |

Check warning on line 333 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L333

Did you really mean 'Cmd'?
| **Strikethrough** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> | <kbd>Control</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> |

Check warning on line 334 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L334

Did you really mean 'Cmd'?
| **Code** | <kbd>Cmd</kbd> + <kbd>E</kbd> | <kbd>Control</kbd> + <kbd>E</kbd> |

Check warning on line 335 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L335

Did you really mean 'Cmd'?
| **Normal text** | <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>0</kbd> | <kbd>Control</kbd> + <kbd>Alt</kbd> + <kbd>0</kbd> |

Check warning on line 336 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L336

Did you really mean 'Cmd'?
| **Heading 1** | <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>1</kbd> | <kbd>Control</kbd> + <kbd>Alt</kbd> + <kbd>1</kbd> |

Check warning on line 337 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L337

Did you really mean 'Cmd'?
| **Heading 2** | <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>2</kbd> | <kbd>Control</kbd> + <kbd>Alt</kbd> + <kbd>2</kbd> |

Check warning on line 338 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L338

Did you really mean 'Cmd'?
| **Heading 3** | <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>3</kbd> | <kbd>Control</kbd> + <kbd>Alt</kbd> + <kbd>3</kbd> |

Check warning on line 339 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L339

Did you really mean 'Cmd'?
| **Heading 4** | <kbd>Cmd</kbd> + <kbd>Alt</kbd> + <kbd>4</kbd> | <kbd>Control</kbd> + <kbd>Alt</kbd> + <kbd>4</kbd> |

Check warning on line 340 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L340

Did you really mean 'Cmd'?
| **Ordered list** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>7</kbd> | <kbd>Control</kbd> + <kbd>Shift</kbd> + <kbd>7</kbd> |

Check warning on line 341 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L341

Did you really mean 'Cmd'?
| **Unordered list** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>8</kbd> | <kbd>Control</kbd> + <kbd>Shift</kbd> + <kbd>8</kbd> |

Check warning on line 342 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L342

Did you really mean 'Cmd'?
| **Blockquote** | <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> | <kbd>Control</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd> |

Check warning on line 343 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L343

Did you really mean 'Cmd'?
| **Subscript** | <kbd>Cmd</kbd> + <kbd>,</kbd> | <kbd>Control</kbd> + <kbd>,</kbd> |

Check warning on line 344 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L344

Did you really mean 'Cmd'?
| **Superscript** | <kbd>Cmd</kbd> + <kbd>.</kbd> | <kbd>Control</kbd> + <kbd>.</kbd> |

Check warning on line 345 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L345

Did you really mean 'Cmd'?

## Export documentation to PDF

The web editor includes a powerful docs-to-PDF export feature that allows you to convert your entire documentation site or specific pages into professional PDF documents. This feature is ideal for creating offline documentation, sharing documentation with stakeholders, or generating printable versions of your content.

### How to export documentation as PDF

1. Navigate to your documentation site or specific page you want to export.
2. Access the export options through the web editor's toolbar or settings menu.
3. Select **Export to PDF** from the available export formats.
4. Choose your export preferences:
- **Full site export**: Download your entire documentation as a comprehensive PDF
- **Single page export**: Export individual pages or sections
- **Custom selection**: Choose specific pages to include in your PDF
5. Configure PDF settings such as page layout, margins, and formatting options.
6. Click **Generate PDF** to start the export process.
7. Download your PDF file once the generation is complete.

### PDF export features

- **Professional formatting**: Maintains your documentation's styling and branding in the PDF output
- **Table of contents**: Automatically generates navigable bookmarks and table of contents
- **Cross-references**: Preserves internal links as clickable references within the PDF
- **Image optimization**: Ensures high-quality images in the exported document
- **Custom styling**: Apply PDF-specific formatting and page breaks
- **Batch export**: Export multiple documentation sections simultaneously

### Use cases for PDF export

- **Offline documentation**: Provide documentation access without internet connectivity
- **Client deliverables**: Share professional documentation packages with clients

Check warning on line 376 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L376

Did you really mean 'deliverables'?
- **Compliance requirements**: Meet regulatory needs for document archival
- **Print-friendly versions**: Create printable documentation for training materials
- **Backup documentation**: Maintain offline copies of your documentation
- **Stakeholder sharing**: Distribute documentation to non-technical team members

<Tip>
PDF exports maintain the same content structure and formatting as your live documentation, ensuring consistency across all formats.
</Tip>

## Troubleshooting

Here are solutions to common issues you might encounter with the web editor.
Expand Down Expand Up @@ -385,4 +424,18 @@
2. Refresh the page and try again.
3. Contact support if the issue persists.
</Accordion>
<Accordion title="PDF export issues">
**Possible causes:**

- Large documentation sites causing timeout
- Complex formatting or components not supported in PDF
- Network connectivity during export process

**Solutions:**

1. Try exporting smaller sections instead of the full site.
2. Check that all images and assets are properly loaded.
3. Ensure stable internet connection during export.
4. Contact support if PDF generation consistently fails.
</Accordion>
</AccordionGroup>
9 changes: 9 additions & 0 deletions features.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Features

## PDF Export

Mintlify enables you to export your documentation as PDF for offline reading, distribution, or archiving purposes. This powerful feature allows you to create downloadable documentation that can be shared with stakeholders, stored for compliance requirements, or accessed without an internet connection.

The PDF export functionality maintains your documentation's formatting and structure while creating professional, printable documents that preserve your content's integrity.

[Learn more about PDF export →](/features/pdf-export)
Loading