diff --git a/ai/markdown-export.mdx b/ai/markdown-export.mdx index 61a63859f..b88926301 100644 --- a/ai/markdown-export.mdx +++ b/ai/markdown-export.mdx @@ -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. Open this page as Markdown -## Keyboard shortcut +### Keyboard shortcut Press Command + C (Ctrl + C on Windows) to copy a page as Markdown to your clipboard. + +## 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 +- **Compliance and archival**: Maintain versioned documentation records +- **Print-friendly format**: Create physical copies of your documentation diff --git a/api-playground/asyncapi/playground.mdx b/api-playground/asyncapi/playground.mdx index 9bd34aa2b..e52dc1e6e 100644 --- a/api-playground/asyncapi/playground.mdx +++ b/api-playground/asyncapi/playground.mdx @@ -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" --- + +# 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. diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index de396cc57..2a8bc79e1 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -508,6 +508,39 @@ openapi-schema: "schema-key" +## 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 + + + PDF export functionality may have limitations on very large documentation sites. + Consider exporting specific sections if you encounter issues with the full site export. + + +### 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 + ## Webhooks Webhooks are HTTP callbacks that your API sends to notify external systems when events occur. Webhooks are supported in OpenAPI 3.1+ documents. diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index 1eb0f19c2..d67f72efb 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -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. + + 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. + diff --git a/api-reference/assistant/search.mdx b/api-reference/assistant/search.mdx index aad5f0e85..6632c711b 100644 --- a/api-reference/assistant/search.mdx +++ b/api-reference/assistant/search.mdx @@ -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 +- **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 +- **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. diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 2a446431d..ccf127f76 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -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 diff --git a/api-reference/update/status.mdx b/api-reference/update/status.mdx index 9e2e93b66..c01ef60f3 100644 --- a/api-reference/update/status.mdx +++ b/api-reference/update/status.mdx @@ -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 +- **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: +- 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. diff --git a/api-reference/update/trigger.mdx b/api-reference/update/trigger.mdx index 26b0968f3..a0f085737 100644 --- a/api-reference/update/trigger.mdx +++ b/api-reference/update/trigger.mdx @@ -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. diff --git a/docs.json b/docs.json index a137f89a6..3e90cd413 100644 --- a/docs.json +++ b/docs.json @@ -516,4 +516,4 @@ "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8" } } -} +} \ No newline at end of file diff --git a/editor.mdx b/editor.mdx index 12bfb13e4..17ef231a5 100644 --- a/editor.mdx +++ b/editor.mdx @@ -344,6 +344,45 @@ The web editor supports all common keyboard shortcuts such as copy, paste, undo, | **Subscript** | Cmd + , | Control + , | | **Superscript** | Cmd + . | Control + . | +## 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 +- **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 + + + PDF exports maintain the same content structure and formatting as your live documentation, ensuring consistency across all formats. + + ## Troubleshooting Here are solutions to common issues you might encounter with the web editor. @@ -385,4 +424,18 @@ Here are solutions to common issues you might encounter with the web editor. 2. Refresh the page and try again. 3. Contact support if the issue persists. + + **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. + diff --git a/features.mdx b/features.mdx new file mode 100644 index 000000000..de2f8d61e --- /dev/null +++ b/features.mdx @@ -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) \ No newline at end of file diff --git a/features/pdf-export.mdx b/features/pdf-export.mdx new file mode 100644 index 000000000..5ea8de0e5 --- /dev/null +++ b/features/pdf-export.mdx @@ -0,0 +1,239 @@ +# Docs to PDF Export + +Export your entire documentation site as a comprehensive PDF document for offline access, distribution, and archival purposes. + +## Overview + +The **Docs to PDF** export feature allows you to convert your complete documentation site into a single, well-formatted PDF file. This powerful documentation export capability enables teams to create downloadable documentation that can be shared, printed, or accessed offline without losing the structure and formatting of your original content. + +Whether you need to distribute documentation to clients, create offline documentation for field teams, or maintain archival copies of your docs, the PDF export feature provides a seamless solution for converting your web-based documentation into a portable format. + +## Key Features + +- **Complete site export**: Export your entire documentation site as a single PDF +- **Preserved formatting**: Maintains original styling, code blocks, and visual elements +- **Table of contents**: Automatically generates a navigable table of contents +- **Cross-references**: Converts internal links to page references within the PDF +- **Custom styling**: Apply PDF-specific styling and branding +- **Batch processing**: Export multiple sections or the entire site at once + +## How to Export Documentation to PDF + +### Step-by-Step Export Process + +1. **Access the Export Feature** + - Navigate to your documentation dashboard + - Look for the "Export" or "Download" button in the main navigation + - Select "Export to PDF" from the dropdown menu + +2. **Configure Export Settings** + - Choose export scope (entire site, specific sections, or custom selection) + - Select PDF format options (page size, orientation, margins) + - Configure table of contents settings + - Set header and footer preferences + +3. **Customize PDF Appearance** + - Apply your brand colors and logos + - Choose font styles and sizes + - Configure page numbering + - Set document metadata (title, author, subject) + +4. **Initiate Export Process** + - Click "Generate PDF" to start the export + - Monitor the progress indicator + - Wait for the processing to complete (time varies based on content size) + +5. **Download Your PDF** + - Once processing is complete, click "Download PDF" + - The file will be saved to your default downloads folder + - Verify the PDF opens correctly and contains all expected content + +### Quick Export Options + +For faster exports, use these shortcuts: + +- **Single page export**: Use the page-level export button on individual documentation pages +- **Section export**: Export specific documentation sections using the section menu +- **Scheduled exports**: Set up automated PDF generation for regular documentation updates + +## Configuration Options + +### Export Scope Settings + +```yaml +# Example configuration for PDF export scope +export: + scope: "full-site" # Options: full-site, selected-pages, single-section + include_navigation: true + include_search: false + max_depth: 5 +``` + +### PDF Format Configuration + +```yaml +# PDF formatting options +pdf: + page_size: "A4" # Options: A4, Letter, Legal, A3 + orientation: "portrait" # Options: portrait, landscape + margins: + top: "20mm" + bottom: "20mm" + left: "15mm" + right: "15mm" + font_size: "12pt" + line_height: 1.4 +``` + +### Styling and Branding + +```yaml +# Custom PDF styling +styling: + cover_page: true + table_of_contents: true + page_numbers: true + headers: true + footers: true + logo: "/assets/company-logo.png" + primary_color: "#007acc" + font_family: "Arial, sans-serif" +``` + +### Content Processing Options + +```yaml +# Content handling settings +content: + include_code_blocks: true + syntax_highlighting: true + include_images: true + image_quality: "high" # Options: low, medium, high + link_handling: "page_references" # Options: preserve, page_references, remove + max_image_width: "100%" +``` + +## Best Practices + +### Content Optimization + +- **Review content before export**: Ensure all pages are complete and up-to-date +- **Optimize images**: Use high-quality images that will render well in PDF format +- **Check code blocks**: Verify that code snippets are properly formatted and readable +- **Test internal links**: Ensure cross-references work correctly in the PDF output + +### PDF Structure + +- **Logical organization**: Structure your documentation with clear hierarchies +- **Consistent formatting**: Use consistent heading styles throughout your documentation +- **Page breaks**: Consider manual page breaks for better PDF flow +- **Table of contents**: Enable TOC generation for easier navigation + +### Performance Considerations + +- **Large documentation sites**: Consider splitting very large sites into multiple PDFs +- **Image optimization**: Compress images to reduce PDF file size +- **Processing time**: Allow adequate time for large documentation exports +- **Resource usage**: Schedule exports during off-peak hours for better performance + +## Limitations and Considerations + +### Technical Limitations + +- **Interactive elements**: Dynamic content and interactive features won't function in PDF +- **Responsive design**: Mobile-specific layouts may not translate perfectly to PDF +- **External links**: Links to external websites will be preserved but won't be clickable in all PDF viewers +- **Video content**: Embedded videos will appear as static images or placeholders + +### Content Limitations + +- **File size limits**: Very large documentation sites may hit file size restrictions +- **Processing time**: Complex sites with many images may take significant time to process +- **Font compatibility**: Some custom fonts may not render correctly in PDF format +- **Color accuracy**: Colors may appear differently in PDF compared to web display + +### Browser Compatibility + +- **PDF viewer support**: Ensure your target audience has compatible PDF viewing software +- **Download capabilities**: Some corporate networks may restrict large file downloads +- **Mobile viewing**: Large PDF files may be challenging to view on mobile devices + +## Use Cases and Benefits + +### Business Applications + +**Client Documentation Delivery** +- Provide complete API documentation to integration partners +- Deliver user manuals and technical specifications to customers +- Create professional documentation packages for proposals and contracts + +**Compliance and Auditing** +- Generate timestamped documentation snapshots for compliance requirements +- Create archival copies of documentation for regulatory purposes +- Maintain version-controlled PDF records of documentation changes + +**Offline Access Scenarios** +- Enable field teams to access documentation without internet connectivity +- Provide documentation for secure environments with limited web access +- Create portable documentation for trade shows and presentations + +### Educational and Training + +**Training Materials** +- Convert online courses and tutorials into printable training manuals +- Create comprehensive study guides from documentation content +- Develop offline reference materials for workshops and seminars + +**Knowledge Preservation** +- Archive institutional knowledge in portable format +- Create backup copies of critical documentation +- Preserve documentation formatting across different systems and platforms + +### Marketing and Sales + +**Professional Presentations** +- Generate polished documentation for client meetings +- Create branded technical documentation for marketing materials +- Develop comprehensive product documentation for sales teams + +## Troubleshooting Common Issues + +### Export Failures + +**Large File Processing** +- Reduce export scope to smaller sections +- Optimize images before export +- Check available server resources + +**Formatting Issues** +- Review CSS styles for PDF compatibility +- Test with different page size settings +- Adjust margin and spacing configurations + +**Missing Content** +- Verify all pages are published and accessible +- Check export scope settings +- Review content permissions and visibility + +### Quality Issues + +**Poor Image Quality** +- Increase image quality settings in configuration +- Use higher resolution source images +- Check image compression settings + +**Text Rendering Problems** +- Verify font availability and licensing +- Use web-safe fonts for better compatibility +- Check character encoding settings + +## Getting Support + +If you encounter issues with the PDF export feature: + +1. **Check the documentation**: Review this guide and any platform-specific documentation +2. **Test with smaller exports**: Try exporting individual pages or sections first +3. **Contact support**: Reach out to your platform support team with specific error messages +4. **Community forums**: Check community discussions for similar issues and solutions + +The Docs to PDF export feature provides a powerful way to make your documentation more accessible and portable. By following these guidelines and best practices, you can create high-quality PDF documentation that serves your team's and users' needs effectively. \ No newline at end of file diff --git a/guides/assistant.mdx b/guides/assistant.mdx index 534035146..0cc25501f 100644 --- a/guides/assistant.mdx +++ b/guides/assistant.mdx @@ -72,6 +72,47 @@ Structure your documentation to help the assistant provide accurate, relevant an - Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference. +## Docs to PDF export + +Export your entire documentation site as a PDF for offline access, sharing, or archival purposes. The docs to PDF feature creates a comprehensive document that maintains your site's structure and formatting. + +### How to export docs to PDF + +1. Navigate to your documentation site settings or dashboard. +2. Look for the "Export" or "PDF Export" option. +3. Select the pages or sections you want to include in the PDF. +4. Configure export settings such as page formatting and table of contents. +5. Click "Generate PDF" to start the export process. +6. Download the generated PDF file once processing is complete. + +### PDF export features + +The docs to PDF export includes: + +- **Complete site structure** with proper navigation and hierarchy +- **Formatted content** that preserves styling and layout +- **Images and diagrams** embedded directly in the PDF +- **Table of contents** for easy navigation +- **Cross-references** converted to page numbers +- **Code blocks** with syntax highlighting preserved +- **Searchable text** for finding specific content + +### Use cases for PDF export + +- **Offline documentation** for teams without internet access +- **Client deliverables** and project documentation packages +- **Compliance and archival** requirements for documentation +- **Print-friendly versions** for physical distribution +- **Backup copies** of your documentation +- **Training materials** for workshops and presentations + + + - Organize content with clear headings for better PDF structure + - Use descriptive alt text for images to improve accessibility + - Keep code examples concise for better PDF formatting + - Consider page breaks when structuring long content sections + + ## Exporting and analyzing queries Review and export queries from your dashboard to understand how people interact with your documentation and identify improvement opportunities. Some ways that analyzing queries can help you improve your documentation: @@ -90,4 +131,4 @@ You can explore queries from your [dashboard](https://dashboard.mintlify.com/pro - Summarize the most common themes of the queries. - List any queries that had no sources cited. - Find patterns in unsuccessful interactions. - + \ No newline at end of file diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx index cb30c28d5..1f49a0168 100644 --- a/guides/claude-code.mdx +++ b/guides/claude-code.mdx @@ -132,3 +132,35 @@ Share your refined `CLAUDE.md` file with your team to ensure consistent document ### Custom commands Create reusable slash commands in `.claude/commands/` for frequently used documentation tasks specific to your project or team. + +## Documentation Export Features + +### Export to PDF +Claude Code can help you prepare and optimize your documentation for PDF export. Many documentation platforms, including Mintlify, offer built-in PDF export functionality that allows users to download entire documentation sites or specific sections as PDF files. + +**Key benefits of PDF export:** +- Offline access to documentation +- Easy sharing and distribution +- Professional presentation format +- Archive-ready documentation + +**Optimizing docs for PDF export with Claude Code:** + +**Example prompt:** +```text wrap +Review our documentation structure and suggest improvements for better PDF export formatting, including page breaks, table of contents, and print-friendly layouts +``` + +**Example prompt:** +```text wrap +Optimize our documentation headings and structure to create a logical PDF table of contents when exported +``` + +**SEO considerations for PDF-ready documentation:** +- Clear hierarchical heading structure (H1, H2, H3) +- Descriptive section titles that work in both web and PDF contexts +- Comprehensive table of contents structure +- Self-contained content that reads well sequentially +- Proper image sizing and alt text for print formats + +Claude Code can help ensure your documentation is structured optimally for both web viewing and PDF export, maintaining readability and navigation in both formats. diff --git a/guides/cursor.mdx b/guides/cursor.mdx index 862c1441f..46743d363 100644 --- a/guides/cursor.mdx +++ b/guides/cursor.mdx @@ -379,6 +379,66 @@ Use updates for changelogs: - Resolved authentication timeout problems +#### PDF export functionality + +Document PDF export features for documentation sites: + + +The docs to PDF export feature allows users to download their entire documentation site as a PDF file for offline reading, sharing, or archival purposes. + + + + + Configure PDF export settings in your `mintlify.json` file: + + ```json + { + "pdf": { + "enabled": true, + "filename": "documentation.pdf", + "includePages": ["overview", "api-reference", "guides"] + } + } + ``` + + + Use descriptive filenames that include your product name for better SEO and user experience. + + + + + Control which pages are included in the PDF export: + + + Array of page slugs to include in the PDF. Leave empty to include all pages. + + + + Array of page slugs to exclude from the PDF export. + + + + Custom filename for the downloaded PDF file. + + + + + Users can download the PDF through the export menu or direct URL: + + ```bash + https://your-docs-site.com/export/pdf + ``` + + + The PDF will include all configured pages with proper formatting and navigation. + + + + + +PDF export may take several minutes for large documentation sites. Consider limiting the number of pages for better performance. + + ## Required page structure Every documentation page must begin with YAML frontmatter: diff --git a/guides/geo.mdx b/guides/geo.mdx index d4294ad19..dbbf1ae9d 100644 --- a/guides/geo.mdx +++ b/guides/geo.mdx @@ -86,6 +86,33 @@ Add to your `docs.json`: LLMs.txt files help AI systems understand your documentation structure, similar to how sitemaps help search engines. Mintlify automatically generates LLMs.txt files for your docs. No configuration is required. +## Docs to PDF export + +Mintlify provides a built-in docs to PDF export feature that allows users to download your entire documentation site as a PDF file. This feature enhances user experience and provides an offline reference option. + +### How to enable PDF export + +The PDF export functionality is automatically available in your documentation site. Users can access it through the export options in your documentation interface. + +### SEO benefits of PDF exports + +PDF exports can improve your documentation's discoverability: + +- **Additional content format** - Search engines can index PDF versions alongside web pages +- **Keyword optimization** - PDFs preserve your content structure and keywords +- **Offline accessibility** - Users can reference documentation without internet access +- **Shareable format** - PDFs are easily shared and distributed + +### Best practices for PDF-optimized content + +To ensure your PDF exports are well-structured and SEO-friendly: + +- Use clear, descriptive headings throughout your documentation +- Include a comprehensive table of contents +- Ensure proper heading hierarchy (H1 → H2 → H3) +- Add meaningful alt text to images that will appear in the PDF +- Structure content with logical flow for offline reading + ## Testing your documentation Test various AI tools with questions about your product and documentation to see how well your docs are being cited. @@ -93,7 +120,9 @@ Test various AI tools with questions about your product and documentation to see **Ask AI assistants specific questions about your docs:** - "How do I set up authentication using this API?" - "Walk me through the installation process step by step" +- "How can I export documentation as PDF?" **Check that tools provide:** - Correct code samples - Accurate step-by-step instructions +- Information about PDF export capabilities diff --git a/guides/migration.mdx b/guides/migration.mdx index 58a8629f3..b813bc476 100644 --- a/guides/migration.mdx +++ b/guides/migration.mdx @@ -168,6 +168,45 @@ To migrate your content to Mintlify, you will need: +## Export documentation as PDF + +Once your documentation is migrated to Mintlify, you can export your entire documentation site as a PDF for offline access, distribution, or archival purposes. + +### PDF export features + +The docs to PDF export functionality allows you to: + +- **Download complete documentation** - Export your entire documentation site as a single PDF file +- **Preserve formatting** - Maintain your documentation's visual styling, code blocks, and images in the PDF +- **Offline access** - Share documentation with stakeholders who need offline access +- **Print-ready format** - Generate PDFs optimized for printing and physical distribution +- **Version archiving** - Create PDF snapshots of your documentation for compliance or versioning + +### How to export your docs to PDF + +1. Navigate to your published Mintlify documentation site +2. Look for the PDF export option in your site's navigation or settings +3. Click "Export to PDF" or "Download as PDF" +4. Wait for the PDF generation process to complete +5. Download the generated PDF file containing your complete documentation + +The PDF export maintains your documentation's structure, including: +- Table of contents with clickable navigation +- Properly formatted code blocks with syntax highlighting +- Images and diagrams +- Custom styling and branding +- Page breaks and section organization + +### Use cases for PDF export + +**Team collaboration**: Share comprehensive documentation with team members who prefer offline reading or need to review content without internet access. + +**Client deliverables**: Provide clients with professional PDF versions of your API documentation or user guides as part of project deliverables. + +**Compliance and archiving**: Meet regulatory requirements by maintaining PDF archives of your documentation at specific points in time. + +**Print materials**: Create physical copies of your documentation for training sessions, workshops, or reference materials. + ## Post-migration checklist After completing your migration (automated or manual), we recommend checking: @@ -178,5 +217,6 @@ After completing your migration (automated or manual), we recommend checking: - Images and assets load correctly - Code blocks display with proper syntax highlighting - Search functionality works +- PDF export functionality works correctly - Deployment is configured - Custom domain is set up diff --git a/index.mdx b/index.mdx index 92bfd2201..4558bb5bd 100644 --- a/index.mdx +++ b/index.mdx @@ -68,6 +68,13 @@ export const HeroCard = ({ filename, title, description, href }) => { description="Build rich, interactive documentation with our ready-to-use components" href="/text" /> + + diff --git a/installation.mdx b/installation.mdx index 988d4e196..2242b14c6 100644 --- a/installation.mdx +++ b/installation.mdx @@ -136,6 +136,37 @@ mint migrate-mdx This command converts individual MDX endpoint pages to autogenerated pages defined in your `docs.json`, moves MDX content to the `x-mint` extension in your OpenAPI specification, and updates your navigation. See [Migrating from MDX](/api-playground/migrating-from-mdx) for detailed information. +### Exporting documentation to PDF + +The CLI provides a powerful docs-to-PDF export feature that allows you to generate and download your entire documentation site as a PDF file. This is particularly useful for offline documentation access, creating printable versions, or archiving documentation snapshots. + +```bash +mint export-pdf +``` + +This command will: +- Generate a comprehensive PDF export of your documentation site +- Include all pages, images, and formatting from your docs +- Create a downloadable PDF file with proper navigation and structure +- Maintain the visual styling and layout of your documentation + + + The PDF export feature is perfect for creating offline documentation copies, sharing documentation with stakeholders who prefer PDF format, or creating archived versions of your docs for compliance purposes. + + +You can also customize the PDF export with additional options: + +```bash +mint export-pdf --output my-docs.pdf --include-toc +``` + +The PDF export supports: +- Table of contents generation +- Cross-references and internal links +- Images and diagrams +- Code syntax highlighting +- Custom styling and branding + ## Formatting While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files. diff --git a/integrations/analytics/hotjar.mdx b/integrations/analytics/hotjar.mdx index 599ebb08d..65bcd0cd9 100644 --- a/integrations/analytics/hotjar.mdx +++ b/integrations/analytics/hotjar.mdx @@ -12,3 +12,32 @@ Add the following to your `docs.json` file to send analytics to HotJar. } } ``` + +## Export Documentation to PDF + +Transform your documentation site into a professional PDF document for offline access, sharing, and archiving. The docs to PDF export feature allows you to download your entire documentation or specific sections as high-quality PDF files. + +### PDF Export Features + +- **Complete site export**: Download your entire documentation as a single PDF +- **Section-specific exports**: Generate PDFs for individual sections or pages +- **Professional formatting**: Maintains your site's styling and branding in PDF format +- **Offline access**: Access documentation without internet connectivity +- **Easy sharing**: Share documentation with stakeholders, clients, or team members +- **Archival purposes**: Create permanent records of documentation versions + +### How to Export Documentation as PDF + +1. Navigate to your documentation site +2. Look for the "Export to PDF" option in the navigation menu or settings +3. Select the content you want to include in the PDF export +4. Choose your formatting preferences +5. Click "Generate PDF" to create and download your documentation + +### Use Cases for PDF Documentation Export + +- **Client presentations**: Share professional documentation with clients +- **Offline reference**: Access docs when internet isn't available +- **Compliance requirements**: Meet regulatory needs for document archiving +- **Team onboarding**: Provide comprehensive guides to new team members +- **Version control**: Maintain historical records of documentation changes diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index d67dc6ccf..9b06914bc 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -3,7 +3,11 @@ title: "Analytics integrations" description: "Integrate with an analytics platform to track events" --- -Automatically send data about your documentation engagement to your third party analytics provider. +Automatically send data about your documentation engagement to your third party analytics provider. Track user interactions, page views, and document exports including PDF downloads to optimize your documentation experience. + +## PDF Export Tracking + +Monitor how users export your documentation with comprehensive PDF download analytics. Track when visitors download your docs as PDF files, which sections are most commonly exported, and user engagement with your downloadable documentation. This data helps you understand content preferences and optimize your documentation for both web and PDF formats. ## All integrations diff --git a/quickstart.mdx b/quickstart.mdx index 4678c7ccd..efad15b23 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -233,6 +233,9 @@ Congratulations! You have successfully deployed your documentation site with Min Create interactive API references with OpenAPI and AsyncAPI specifications. + + Generate and download PDF versions of your documentation for offline sharing and distribution. + ## Troubleshooting diff --git a/settings.mdx b/settings.mdx index a8ab4b7c2..d44bfce3f 100644 --- a/settings.mdx +++ b/settings.mdx @@ -870,6 +870,69 @@ See [Themes](themes) for more information. +### Export + + + Documentation export settings for generating downloadable formats. + + + + PDF export configuration for converting documentation to downloadable PDF format. + + + + Whether to enable PDF export functionality. When enabled, users can download the entire documentation site as a PDF file. Defaults to `false`. + + + Custom title for the exported PDF document. If not specified, uses the site name from the `name` field. + + + Author name to include in the PDF metadata for SEO and document properties. + + + Subject or description to include in the PDF metadata for better categorization and search indexing. + + + Keywords to include in the PDF metadata for improved searchability and SEO optimization. + + + Whether to include the navigation structure in the exported PDF. Defaults to `true`. + + + Page size for the exported PDF document. Defaults to `A4`. + + + Page orientation for the exported PDF. Defaults to `portrait`. + + + Custom margins for the PDF pages. + + + + Top margin (e.g., "1in", "2.54cm"). Defaults to "1in". + + + Bottom margin (e.g., "1in", "2.54cm"). Defaults to "1in". + + + Left margin (e.g., "1in", "2.54cm"). Defaults to "1in". + + + Right margin (e.g., "1in", "2.54cm"). Defaults to "1in". + + + + + List of page paths to exclude from the PDF export. Useful for excluding changelog, API reference, or other dynamic content. + + + Custom CSS styles to apply specifically to the PDF export for better print formatting and layout optimization. + + + + + + ### Errors