# Mintlify

> Mintlify is a platform for building and hosting documentation websites. It provides a set of tools and services for maintaining documentation and making it accessible to AI agents.

## Docs

- [Format text](https://smartac-justin-client-exports.mintlify.app/create/text.md): Format text in your documentation with Markdown headings, bold, italic, links, blockquotes, and other inline styling options in MDX pages.
- [Credit pricing](https://smartac-justin-client-exports.mintlify.app/credits.md): Understand how Mintlify credits work for assistant messages, agent runs, and automations, including how we bill credit tiers, overages, and rollovers.
- [Custom domain](https://smartac-justin-client-exports.mintlify.app/customize/custom-domain.md): Host your documentation on a custom domain with DNS configuration, automatic TLS certificates, and subdomain or subpath routing options.
- [Custom scripts](https://smartac-justin-client-exports.mintlify.app/customize/custom-scripts.md): Add custom JavaScript and CSS scripts to your documentation site for analytics, widgets, styling overrides, and third-party integrations.
- [Fonts](https://smartac-justin-client-exports.mintlify.app/customize/fonts.md): Customize typography on your documentation site with Google Fonts or self-hosted font files for headings, body text, and code blocks.
- [React](https://smartac-justin-client-exports.mintlify.app/customize/react-components.md): Build interactive and reusable elements with custom React components in your Mintlify documentation using JSX, state, and client-side logic.
- [Audit logs](https://smartac-justin-client-exports.mintlify.app/dashboard/audit-logs.md): Review audit logs to track actions performed by organization members, including deployments, configuration changes, and permission updates.
- [Deployment permissions](https://smartac-justin-client-exports.mintlify.app/dashboard/permissions.md): Understand deployment permission levels for organization members versus external contributors, including branch protection and merge access.
- [Roles](https://smartac-justin-client-exports.mintlify.app/dashboard/roles.md): Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify.
- [Security contact](https://smartac-justin-client-exports.mintlify.app/dashboard/security-contact.md): Configure a security contact email address for your organization to receive vulnerability reports, security alerts, and compliance updates.
- [Single sign-on (SSO)](https://smartac-justin-client-exports.mintlify.app/dashboard/sso.md): Set up single sign-on with SAML or OIDC identity providers like Okta, Azure AD, and Google Workspace for secure team authentication.
- [Authentication setup](https://smartac-justin-client-exports.mintlify.app/deploy/authentication-setup.md): Configure user authentication for your site with OAuth, JWT, password, or Mintlify Auth to control access to pages and API references.
- [CI checks](https://smartac-justin-client-exports.mintlify.app/deploy/ci.md): Automate documentation quality checks in your CI/CD pipeline with broken link detection, linting, grammar validation, and build previews.
- [Deploy at a subpath with Cloudflare Workers](https://smartac-justin-client-exports.mintlify.app/deploy/cloudflare.md): Deploy your Mintlify documentation at a subpath on your domain using Cloudflare Workers with step-by-step setup and DNS configuration.
- [Content Security Policy (CSP) configuration](https://smartac-justin-client-exports.mintlify.app/deploy/csp-configuration.md): Configure Content Security Policy headers to allow Mintlify resources while maintaining security for reverse proxies and strict network policies.
- [Deployments](https://smartac-justin-client-exports.mintlify.app/deploy/deployments.md): Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting.
- [Host docs at a /docs subpath](https://smartac-justin-client-exports.mintlify.app/deploy/docs-subpath.md): Host your Mintlify documentation at a /docs subpath on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy.
- [Offline export](https://smartac-justin-client-exports.mintlify.app/deploy/export.md): Export your documentation site as a self-contained zip archive for offline viewing, internal distribution, or air-gapped environment hosting.
- [GitHub Enterprise Server](https://smartac-justin-client-exports.mintlify.app/deploy/ghes.md): Install and configure the Mintlify GitHub App on your GitHub Enterprise Server instance for automated documentation deployments and syncing.
- [GitHub](https://smartac-justin-client-exports.mintlify.app/deploy/github.md): Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization.
- [GitLab](https://smartac-justin-client-exports.mintlify.app/deploy/gitlab.md): Connect your GitLab repository to Mintlify for automated documentation deployments, merge request previews, and continuous synchronization.
- [Self-hosted GitLab OAuth](https://smartac-justin-client-exports.mintlify.app/deploy/gitlab-self-hosted.md): Connect a self-hosted GitLab instance to Mintlify via OAuth so automations can clone repositories, push commits, and open merge requests on your behalf.
- [Monorepo setup](https://smartac-justin-client-exports.mintlify.app/deploy/monorepo.md): Configure the documentation path and content directory in a monorepo project so Mintlify deploys only from your designated docs folder.
- [Multi-repository deployments](https://smartac-justin-client-exports.mintlify.app/deploy/multi-repo.md): Combine multiple Git repositories into one Mintlify site, with a dedicated URL path for each source repo's content and navigation.
- [Preview deployments](https://smartac-justin-client-exports.mintlify.app/deploy/preview-deployments.md): Get unique preview URLs for each pull request so reviewers can see documentation changes in a live environment before merging to production.
- [Reverse proxy](https://smartac-justin-client-exports.mintlify.app/deploy/reverse-proxy.md): Configure a custom reverse proxy with Nginx, Apache, or Caddy to serve your Mintlify documentation at a subpath on your own domain.
- [AWS Route 53 and CloudFront](https://smartac-justin-client-exports.mintlify.app/deploy/route53-cloudfront.md): Deploy your Mintlify documentation at a subpath on AWS using Route 53 for DNS routing and CloudFront as a CDN with Lambda@Edge functions.
- [Vercel](https://smartac-justin-client-exports.mintlify.app/deploy/vercel.md): Configure Vercel rewrites to serve your Mintlify documentation at a subpath on your main domain with step-by-step vercel.json setup.
- [External proxies with Vercel](https://smartac-justin-client-exports.mintlify.app/deploy/vercel-external-proxies.md): Configure external reverse proxies like Cloudflare or Nginx in front of your Vercel deployment to serve Mintlify docs at a custom subpath.
- [Ask agent](https://smartac-justin-client-exports.mintlify.app/editor/agent.md): Use the editor's built-in AI agent to write content, edit pages, search across your site, upload files, and configure settings from a chat interface.
- [Branching and publishing](https://smartac-justin-client-exports.mintlify.app/editor/branching-and-publishing.md): Understand how branches and protection rules determine what happens when you publish, and how to manage the full review and deployment workflow.
- [Configurations](https://smartac-justin-client-exports.mintlify.app/editor/configurations.md): Edit site branding, appearance, navigation, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync.
- [Git essentials for the editor](https://smartac-justin-client-exports.mintlify.app/editor/git-essentials.md): Understand the Git version control concepts behind the Mintlify editor, including branches, commits, pull requests, and merge workflows.
- [Editor overview](https://smartac-justin-client-exports.mintlify.app/editor/index.md): Create, edit, and publish content in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync.
- [Keyboard shortcuts](https://smartac-justin-client-exports.mintlify.app/editor/keyboard-shortcuts.md): View the complete list of keyboard shortcuts for the Mintlify web editor, including text formatting, navigation, and editing commands.
- [Live preview](https://smartac-justin-client-exports.mintlify.app/editor/live-preview.md): Preview your site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly.
- [Organize navigation](https://smartac-justin-client-exports.mintlify.app/editor/navigation.md): Reorder pages, add groups, and manage your documentation sidebar structure using drag-and-drop in the Mintlify web editor — no docs.json edits needed.
- [Create and edit pages](https://smartac-justin-client-exports.mintlify.app/editor/pages.md): Create pages, edit content, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your content.
- [Editor settings for AI and publishing](https://smartac-justin-client-exports.mintlify.app/editor/settings.md): Configure AI instructions, pull request defaults, draft behavior, and the default merge method to control how the Mintlify web editor publishes changes.
- [How to use the editor](https://smartac-justin-client-exports.mintlify.app/editor/tutorial.md): Step-by-step walkthrough of the Mintlify editor: create a branch, edit pages, share a preview deployment for review, and publish your changes.
- [How to create accessible documentation](https://smartac-justin-client-exports.mintlify.app/guides/accessibility.md): Create accessible documentation following WCAG guidelines with semantic HTML, keyboard navigation, alt text, and inclusive content practices.
- [Tutorial: Build an in-app documentation assistant](https://smartac-justin-client-exports.mintlify.app/guides/assistant-embed.md): Build and embed an in-app documentation assistant that answers user questions with cited information from your Mintlify documentation site.
- [Work with branches](https://smartac-justin-client-exports.mintlify.app/guides/branches.md): Create and manage documentation branches to preview changes, collaborate with teammates, and merge updates before publishing to production.
- [Write documentation with Claude Code](https://smartac-justin-client-exports.mintlify.app/guides/claude-code.md): Configure Claude Code with CLAUDE.md project instructions to write, review, and update your Mintlify documentation following your style guide.
- [Write documentation with Codex](https://smartac-justin-client-exports.mintlify.app/guides/codex.md): Configure OpenAI Codex CLI with project instructions and MCP to write Mintlify documentation that follows your style guide and MDX standards.
- [Configure automerge for GitHub Apps](https://smartac-justin-client-exports.mintlify.app/guides/configure-automerge.md): Set up GitHub workflows to automatically merge Mintlify pull requests by adding the Mintlify bot to your repository's ruleset bypass list.
- [Documentation content templates](https://smartac-justin-client-exports.mintlify.app/guides/content-templates.md): Copy and modify ready-to-use MDX templates for how-to guides, tutorials, concept explanations, and API reference pages in your documentation.
- [Documentation content types](https://smartac-justin-client-exports.mintlify.app/guides/content-types.md): Choose the right documentation type for each page using the Diátaxis framework: tutorials, how-to guides, reference, and explanation.
- [Write documentation with Cursor](https://smartac-justin-client-exports.mintlify.app/guides/cursor.md): Configure Cursor with project rules to write Mintlify documentation that follows your style guide, component usage, and MDX conventions.
- [Headless docs with a custom frontend](https://smartac-justin-client-exports.mintlify.app/guides/custom-frontend.md): Build a headless documentation frontend with Astro while using Mintlify for content management, AI-powered search, and assistant features.
- [Build custom page layouts](https://smartac-justin-client-exports.mintlify.app/guides/custom-layouts.md): Use page modes and components to build custom landing pages, marketing pages, and other non-standard layouts in your Mintlify documentation.
- [Create developer documentation](https://smartac-justin-client-exports.mintlify.app/guides/developer-documentation.md): Build developer documentation that helps engineers integrate with your APIs, SDKs, and tools, including quickstarts, references, and guides.
- [Write documentation with Devin Desktop](https://smartac-justin-client-exports.mintlify.app/guides/devin-desktop.md): Configure Devin Desktop's Cascade AI with workspace rules to write Mintlify documentation that follows your style guide and MDX standards.
- [GEO guide: Optimize docs for AI search and answer engines](https://smartac-justin-client-exports.mintlify.app/guides/geo.md): Optimize your documentation for AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews with Generative Engine Optimization techniques.
- [Git concepts for documentation](https://smartac-justin-client-exports.mintlify.app/guides/git-concepts.md): Learn Git version control fundamentals for docs-as-code workflows, including repositories, branches, commits, and pull request collaboration.
- [Create a help center](https://smartac-justin-client-exports.mintlify.app/guides/help-center.md): Build a self-service help center on Mintlify that helps customers find answers, reduces support ticket volume, and scales with your team.
- [How to measure and improve documentation quality](https://smartac-justin-client-exports.mintlify.app/guides/improving-docs.md): Use analytics, user feedback, and content audits to identify documentation gaps and improve the pages that matter most to your users.
- [Guides](https://smartac-justin-client-exports.mintlify.app/guides/index.md): Browse guides on documentation best practices, content strategy, SEO optimization, accessibility, and docs-as-code workflows for your team.
- [How to set up multi-language documentation](https://smartac-justin-client-exports.mintlify.app/guides/internationalization.md): Set up multi-language documentation with locale-based routing, language switcher navigation, and translated content to reach global audiences.
- [Create a knowledge base](https://smartac-justin-client-exports.mintlify.app/guides/knowledge-base.md): Host your internal knowledge base on Mintlify to consolidate information for your team, improve search, and reduce maintenance burden.
- [How to link documentation pages effectively](https://smartac-justin-client-exports.mintlify.app/guides/linking.md): Create internal links, anchor links, and deep links in your documentation, and maintain link integrity with redirects and broken link checks.
- [How to maintain documentation over time](https://smartac-justin-client-exports.mintlify.app/guides/maintenance.md): Keep documentation accurate and up-to-date with review schedules, ownership models, automated checks, and content lifecycle practices.
- [How to use images, screenshots, and videos in documentation](https://smartac-justin-client-exports.mintlify.app/guides/media.md): Learn when and how to use screenshots, GIFs, and videos in documentation with guidance on format selection, alt text, and long-term maintenance.
- [Migrating MDX API pages to OpenAPI navigation](https://smartac-justin-client-exports.mintlify.app/guides/migrating-from-mdx.md): Migrate your manually written MDX API pages to automated OpenAPI-generated documentation with flexible navigation and endpoint grouping.
- [How to structure documentation navigation](https://smartac-justin-client-exports.mintlify.app/guides/navigation.md): Design documentation navigation that helps users find what they need with clear information architecture, logical grouping, and validated structure.
- [How to improve documentation SEO](https://smartac-justin-client-exports.mintlify.app/guides/seo.md): Improve your documentation's search engine rankings with page titles, keyword research, internal linking, and technical SEO techniques.
- [How to write technical documentation](https://smartac-justin-client-exports.mintlify.app/guides/style-and-tone.md): Write clear, consistent technical documentation with practical guidance on voice, structure, terminology, and tone for developer and product docs.
- [How to understand your documentation audience](https://smartac-justin-client-exports.mintlify.app/guides/understand-your-audience.md): Define your documentation audience, research their goals and knowledge level, and apply those insights to write content that helps them succeed.
- [Use automations](https://smartac-justin-client-exports.mintlify.app/guides/use-automations.md): Use Mintlify automations to automate recurring docs maintenance: choose the right trigger, write effective instructions, and get consistent agent results.
- [Introduction](https://smartac-justin-client-exports.mintlify.app/index.md): Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search.
- [Adobe Analytics](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/adobe.md): Integrate Adobe Analytics with your Mintlify documentation site using Adobe Experience Platform Launch tags for detailed usage tracking.
- [Amplitude](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/amplitude.md): Integrate Amplitude analytics with your Mintlify documentation site to track user behavior, page views, and content engagement metrics.
- [Clarity](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/clarity.md): Integrate Microsoft Clarity with your Mintlify documentation site to capture session recordings, heatmaps, and user interaction analytics.
- [Clearbit](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/clearbit.md): Integrate Clearbit with your Mintlify documentation to enrich visitor data, identify visiting companies, and track enterprise engagement.
- [Fathom](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/fathom.md): Integrate Fathom Analytics with your Mintlify documentation for privacy-focused, GDPR-compliant visitor tracking with a simple site ID setup.
- [Google Analytics 4](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/google-analytics.md): Integrate Google Analytics 4 with your Mintlify documentation to track visitor behavior, page views, and content engagement with your GA4 ID.
- [Google Tag Manager](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/google-tag-manager.md): Integrate Google Tag Manager with your Mintlify documentation to manage analytics tags, conversion tracking, and marketing events centrally.
- [Heap](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/heap.md): Integrate Heap analytics with your Mintlify documentation site to automatically capture user interactions and events for behavioral analysis.
- [Hightouch](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/hightouch.md): Integrate Hightouch with your Mintlify documentation to sync analytics data for audience activation, segmentation, and downstream tool routing.
- [Hotjar](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/hotjar.md): Integrate Hotjar with your Mintlify documentation site to capture session recordings, heatmaps, and user feedback for experience insights.
- [LogRocket](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/logrocket.md): Integrate LogRocket with your Mintlify documentation to replay user sessions, monitor frontend errors, and debug interaction issues in detail.
- [Mixpanel](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/mixpanel.md): Integrate Mixpanel with your Mintlify documentation site to track product analytics, user behavior funnels, and content engagement events.
- [Analytics integrations](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/overview.md): Connect your Mintlify documentation to analytics platforms like Google Analytics, Mixpanel, PostHog, and more to track visitor engagement.
- [Pirsch](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/pirsch.md): Integrate Pirsch with your Mintlify documentation for GDPR-compliant, cookie-free analytics that tracks page views without collecting personal data.
- [Plausible](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/plausible.md): Integrate Plausible Analytics with your Mintlify documentation for lightweight, privacy-respecting visitor tracking without cookies or consent banners.
- [PostHog](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/posthog.md): Integrate PostHog with your Mintlify documentation site to track product analytics, feature usage, and user behavior with your API key.
- [Segment](https://smartac-justin-client-exports.mintlify.app/integrations/analytics/segment.md): Integrate Segment with your Mintlify documentation to route analytics events to downstream tools like warehouses, CRMs, and marketing platforms.
- [Osano](https://smartac-justin-client-exports.mintlify.app/integrations/privacy/osano.md): Integrate Osano with your Mintlify documentation site to manage cookie consent banners, privacy preferences, and regulatory compliance.
- [Privacy integrations](https://smartac-justin-client-exports.mintlify.app/integrations/privacy/overview.md): Connect your Mintlify documentation site to privacy platforms like Osano to manage cookie consent, compliance banners, and user preferences.
- [Speakeasy](https://smartac-justin-client-exports.mintlify.app/integrations/sdks/speakeasy.md): Display autogenerated SDK code samples from Speakeasy in your API playground with multi-language examples for Python, TypeScript, Go, and more.
- [Stainless](https://smartac-justin-client-exports.mintlify.app/integrations/sdks/stainless.md): Display autogenerated SDK code samples from Stainless in your API playground with type-safe examples across Python, TypeScript, and other SDKs.
- [Front](https://smartac-justin-client-exports.mintlify.app/integrations/support/front.md): Integrate Front chat with your Mintlify documentation site so visitors can start customer support conversations directly from your docs pages.
- [Intercom](https://smartac-justin-client-exports.mintlify.app/integrations/support/intercom.md): Integrate the Intercom chat widget into your Mintlify documentation site to provide real-time customer messaging, support, and onboarding help.
- [Support integrations](https://smartac-justin-client-exports.mintlify.app/integrations/support/overview.md): Connect your Mintlify documentation to support platforms like Intercom and Front so visitors can get live help directly from your docs pages.
- [Migrate to Mintlify](https://smartac-justin-client-exports.mintlify.app/migration.md): Migrate your documentation to Mintlify from Docusaurus, ReadMe, GitBook, or another platform with step-by-step instructions and CLI tooling.
- [Analytics](https://smartac-justin-client-exports.mintlify.app/optimize/analytics.md): Track documentation analytics in the Mintlify dashboard to understand page views, visitor trends, search queries, and content effectiveness.
- [Feedback](https://smartac-justin-client-exports.mintlify.app/optimize/feedback.md): Monitor user satisfaction with built-in feedback widgets, page ratings, and thumbs up/down reactions to identify documentation improvement areas.
- [PDF exports](https://smartac-justin-client-exports.mintlify.app/optimize/pdf-exports.md): Export your entire documentation site as a single PDF with a navigable table of contents for offline reading, sharing, and print distribution.
- [Search](https://smartac-justin-client-exports.mintlify.app/optimize/search.md): Configure the in-product search bar on your Mintlify documentation site, including ranking boosts and the number of results returned per query.
- [SEO](https://smartac-justin-client-exports.mintlify.app/optimize/seo.md): Configure meta tags, Open Graph properties, canonical URLs, and page-level SEO settings to improve your documentation's search engine ranking.
- [Hidden pages](https://smartac-justin-client-exports.mintlify.app/organize/hidden-pages.md): Hide documentation pages from the sidebar navigation while keeping them accessible via direct URL, search, or AI assistant for special use cases.
- [Exclude files from publishing](https://smartac-justin-client-exports.mintlify.app/organize/mintignore.md): Exclude specific files and directories from your published documentation using a .mintignore file with glob patterns, similar to .gitignore syntax.
- [Navigation](https://smartac-justin-client-exports.mintlify.app/organize/navigation.md): Configure your documentation site navigation with groups, pages, dropdowns, tabs, and anchors in docs.json to build a sidebar structure.
- [Pages](https://smartac-justin-client-exports.mintlify.app/organize/pages.md): Configure page metadata, titles, descriptions, icons, and layout modes using YAML frontmatter properties at the top of your MDX documentation.
- [Global settings](https://smartac-justin-client-exports.mintlify.app/organize/settings.md): Configure your Mintlify documentation site with docs.json, the required configuration file that controls navigation, appearance, integrations, and more.
- [API settings](https://smartac-justin-client-exports.mintlify.app/organize/settings-api.md): Configure OpenAPI and AsyncAPI specs, the interactive API playground, SDK code examples, and authentication settings in your docs.json file.
- [Appearance and branding](https://smartac-justin-client-exports.mintlify.app/organize/settings-appearance.md): Configure theme, colors, logo, favicon, fonts, and background in docs.json to control the visual identity of your documentation site.
- [Integrations](https://smartac-justin-client-exports.mintlify.app/organize/settings-integrations.md): Connect analytics platforms, chat widgets, and third-party services to your Mintlify documentation site through the docs.json integrations config.
- [docs.json schema reference](https://smartac-justin-client-exports.mintlify.app/organize/settings-reference.md): Complete reference for every docs.json configuration property with types, default values, descriptions, and usage examples for your docs site.
- [SEO and search](https://smartac-justin-client-exports.mintlify.app/organize/settings-seo.md): Configure SEO settings in docs.json including site description, search engine indexing, meta tags, search bar placeholder, and page timestamps.
- [Site structure](https://smartac-justin-client-exports.mintlify.app/organize/settings-structure.md): Configure navbar, navigation groups, footer links, banner, contextual menu, redirects, and other structural elements in your docs.json file.
- [Quickstart](https://smartac-justin-client-exports.mintlify.app/quickstart.md): Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git.
- [What is Mintlify?](https://smartac-justin-client-exports.mintlify.app/what-is-mintlify.md): Mintlify is a documentation platform designed for developers and AI, with smart search, interactive API playgrounds, and built-in analytics.