mintlify.com

# 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

- [Customize agent behavior](https://www.mintlify.com/docs/agent/customize.md): Customize agent behavior with an `AGENTS.md` configuration file to control how the agent handles documentation tasks and follows your conventions.
- [Write effective prompts](https://www.mintlify.com/docs/agent/effective-prompts.md): Write clear, specific prompts to get better results from the Mintlify agent, with examples of effective instructions and tips for common patterns.
- [What is the agent?](https://www.mintlify.com/docs/agent/index.md): Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review.
- [Add the agent to Slack](https://www.mintlify.com/docs/agent/slack.md): Install the Mintlify agent in Slack to ask questions about your product, create content updates from team conversations, and capture knowledge in pull requests.
- [Use cases](https://www.mintlify.com/docs/agent/use-cases.md): Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs.
- [AI-native documentation](https://www.mintlify.com/docs/ai-native.md): Discover how AI-native features enhance reading, writing, and discovering your documentation with the assistant, agent, and MCP server.
- [Contextual menu](https://www.mintlify.com/docs/ai/contextual-menu.md): Add a contextual menu to your docs with one-click AI integrations for ChatGPT, Claude, Perplexity, Google AI Studio, Devin, Devin Desktop, and MCP tools.
- [llms.txt](https://www.mintlify.com/docs/ai/llmstxt.md): Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation.
- [Markdown export](https://www.mintlify.com/docs/ai/markdown-export.md): Export clean Markdown versions of your documentation pages for AI tools, LLM integrations, and automated content processing workflows.
- [Admin Model Context Protocol (MCP) server](https://www.mintlify.com/docs/ai/mintlify-mcp.md): Give AI tools like Claude, ChatGPT, and Cursor write access to your Mintlify content and dashboard so they can edit pages, update settings, and open PRs.
- [Search Model Context Protocol (MCP) server](https://www.mintlify.com/docs/ai/model-context-protocol.md): Connect AI tools like Claude, Cursor, and ChatGPT to your hosted search MCP server so they can search and retrieve content from your site.
- [skill.md](https://www.mintlify.com/docs/ai/skillmd.md): Make your documentation agent-ready with automatically generated skill.md files that describe your product's capabilities for AI agents.
- [Add SDK examples](https://www.mintlify.com/docs/api-playground/adding-sdk-examples.md): Add SDK code samples to your API documentation with autogenerated examples from Speakeasy and Stainless across multiple languages.
- [AsyncAPI setup](https://www.mintlify.com/docs/api-playground/asyncapi-setup.md): Set up real-time WebSocket documentation using AsyncAPI specification files to generate interactive channel and message reference pages.
- [Complex data types](https://www.mintlify.com/docs/api-playground/complex-data-types.md): Describe APIs with flexible schemas using oneOf, anyOf, and allOf keywords for optional properties, polymorphism, and multiple data formats.
- [Manage page visibility](https://www.mintlify.com/docs/api-playground/managing-page-visibility.md): Control which API endpoints appear in your documentation navigation by hiding, filtering, or organizing autogenerated OpenAPI pages.
- [Create manual API pages](https://www.mintlify.com/docs/api-playground/mdx-setup.md): Create API reference pages manually with MDX files when you need full control over layout for small APIs, prototypes, or custom docs.
- [Multiple responses](https://www.mintlify.com/docs/api-playground/multiple-responses.md): Document multiple response variations for API endpoints, including success and error cases, with status codes and example payloads.
- [OpenAPI setup](https://www.mintlify.com/docs/api-playground/openapi-setup.md): Generate interactive API documentation from OpenAPI specification files with automatic endpoint pages, request builders, and navigation.
- [API playground overview](https://www.mintlify.com/docs/api-playground/overview.md): Let developers test API endpoints directly in your documentation with an interactive playground that sends real requests and shows responses.
- [Troubleshooting](https://www.mintlify.com/docs/api-playground/troubleshooting.md): Troubleshoot common issues with API playground configuration, including OpenAPI validation errors, missing endpoints, and auth problems.
- [Detect AI-sounding prose](https://www.mintlify.com/docs/api/admin/deslop.md): Analyzes a documentation page for AI-generated prose and returns flagged passages with suggested human rewrites. Consumes one AI credit per checked page. Pages under 50 words are skipped and not charged.
- [Create agent job](https://www.mintlify.com/docs/api/agent/v2/create-agent-job.md): Creates a new agent job that runs in the background. The job processes the prompt asynchronously — poll the get job endpoint to track progress. If the agent edits files successfully, a pull request is automatically created.
- [Get agent job](https://www.mintlify.com/docs/api/agent/v2/get-agent-job.md): Retrieves the current status and details of an agent job. Poll this endpoint to track job progress.
- [Send follow-up message](https://www.mintlify.com/docs/api/agent/v2/send-message.md): Sends a follow-up message to an existing agent job. The message is processed asynchronously — poll the get job endpoint to track progress.
- [Get assistant caller stats](https://www.mintlify.com/docs/api/analytics/assistant-caller-stats.md): Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range.
- [Get assistant conversations](https://www.mintlify.com/docs/api/analytics/assistant-conversations.md): Returns paginated AI assistant conversation history
- [Get feedback](https://www.mintlify.com/docs/api/analytics/feedback.md): Returns paginated user feedback with optional filtering
- [Get feedback by page](https://www.mintlify.com/docs/api/analytics/feedback-by-page.md): Returns feedback counts aggregated by documentation page path (thumbs up/down for contextual feedback, code snippet count, and total per page)
- [Get search queries](https://www.mintlify.com/docs/api/analytics/searches.md): Returns paginated documentation search terms for the date range, ordered by hit count descending. Each row includes click-through rate, the most-clicked result path for that query (if any), and the last time the term was searched. `totalSearches` is the total number of search query events in the sam…
- [Get page views](https://www.mintlify.com/docs/api/analytics/views.md): Returns per-path and site-wide content view event counts, split by human and AI traffic.
- [Get unique visitors](https://www.mintlify.com/docs/api/analytics/visitors.md): Returns per-path and site-wide approximate distinct visitors by traffic type. The `total` field is deduplicated across human and AI (union of distinct visitor IDs with any qualifying content view).
- [Create assistant message](https://www.mintlify.com/docs/api/assistant/create-assistant-message-v2.md): Generates a response message from the assistant for the specified domain. Compatible with AI SDK v5+.
- [Get page content](https://www.mintlify.com/docs/api/assistant/get-page-content.md): Retrieve the full text content of a specific documentation page by its path. Use this after a search to fetch the complete content of a matching page.
- [Search documentation](https://www.mintlify.com/docs/api/assistant/search.md): Perform semantic and keyword searches across your documentation with configurable filtering and pagination.
- [Trigger automation](https://www.mintlify.com/docs/api/automations/trigger.md): Trigger a scheduled automation to run immediately, instead of waiting for its next scheduled time. Useful for running automations from CI/CD pipelines, like a GitHub Action that runs on every merge to your default branch. Only scheduled (custom schedule) automations can be triggered. The run picks u…
- [Mintlify REST API introduction](https://www.mintlify.com/docs/api/introduction.md): Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically.
- [Trigger preview deployment](https://www.mintlify.com/docs/api/preview/trigger.md): Create or update a preview deployment for a specific branch. If a preview already exists for the branch, it triggers a redeployment. Returns a status ID to track progress and the preview URL.
- [Generate export bundle](https://www.mintlify.com/docs/api/static-export/generate-bundle.md): Package a completed static export job into a single archive and return a download link. The link is a presigned S3 URL — download it before `expiresAt`.
- [Get static export job status](https://www.mintlify.com/docs/api/static-export/get-job-status.md): Retrieve the current status and progress of a static export job. Poll this endpoint after starting a job until `status` is `completed` (or `failed`).
- [Static export](https://www.mintlify.com/docs/api/static-export/overview.md): Generate a self-contained static export of your documentation and download it as a single bundle through the Mintlify REST API for self-hosting.
- [Start static export job](https://www.mintlify.com/docs/api/static-export/start-job.md): Start a static export job for a deployment. The job pre-renders your documentation into a self-contained set of static HTML, RSC, and asset files. Returns a job ID you can use to poll status and, once complete, generate a downloadable bundle.
- [Get deployment status](https://www.mintlify.com/docs/api/update/status.md): Get the status of an update from the status ID
- [Trigger deployment](https://www.mintlify.com/docs/api/update/trigger.md): Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.
- [Configure the assistant](https://www.mintlify.com/docs/assistant/configure.md): Configure the AI assistant in your Mintlify dashboard: toggle availability, customize responses, add starter questions, set bot protection, and manage billing.
- [Customize assistant behavior](https://www.mintlify.com/docs/assistant/customize.md): Customize the AI assistant by adding an Assistant.md file with system instructions that shape its tone, persona, focus areas, and response behavior.
- [Assistant](https://www.mintlify.com/docs/assistant/index.md): Add an AI-powered chat assistant to your documentation site that answers user questions, cites sources, and generates code examples on demand.
- [Add assistant skills](https://www.mintlify.com/docs/assistant/skills.md): Tune the assistant's responses with topic-specific Markdown guides that the assistant loads on demand to answer specific questions with your team's guidance.
- [Use the assistant](https://www.mintlify.com/docs/assistant/use.md): Open the assistant with keyboard shortcuts, highlighted text, code blocks, file attachments, or URL parameters. Test assistant behavior in local preview.
- [Create a custom automation](https://www.mintlify.com/docs/automations/create.md): Create a custom Mintlify automation with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks.
- [Automations overview](https://www.mintlify.com/docs/automations/index.md): Automate content maintenance with Mintlify automations. Run the agent on a schedule or in response to GitHub and GitLab repository pushes.
- [Automation integrations](https://www.mintlify.com/docs/automations/integrations.md): Connect Slack, Notion, Linear, Jira, Confluence, and other apps so automations can pull live context from the tools your team uses.
- [Manage automations](https://www.mintlify.com/docs/automations/manage.md): Enable, disable, trigger, and delete automations from your dashboard. Configure GitHub or GitLab triggers, schedules, context repos, and automerge.
- [Predefined automations](https://www.mintlify.com/docs/automations/reference.md): Reference for all predefined Mintlify automations, including default trigger, update mode, context repository support, and required configurations.
- [Commands](https://www.mintlify.com/docs/cli/commands.md): Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint broken-links, and more.
- [Mintlify CLI](https://www.mintlify.com/docs/cli/index.md): Use the Mintlify CLI to preview docs locally, test changes in real time, and run accessibility, link, and validation checks before deploying.
- [Install the CLI](https://www.mintlify.com/docs/cli/install.md): Install the Mintlify CLI to preview documentation locally, test changes in real time, and catch build errors before deploying to production.
- [Preview locally](https://www.mintlify.com/docs/cli/preview.md): Run a local preview of your Mintlify documentation site with live reload, full-text search, and AI assistant support using mint dev.
- [Accordions](https://www.mintlify.com/docs/components/accordions.md): Use the accordion component to show and hide content sections, organize related information, and enable progressive disclosure in your docs.
- [Badge](https://www.mintlify.com/docs/components/badge.md): Use the badge component to highlight status indicators, version labels, or metadata inline with customizable colors and hover tooltips.
- [Banner](https://www.mintlify.com/docs/components/banner.md): Add a dismissible banner at the top of your documentation site to display important announcements, release notes, or notifications.
- [Callouts](https://www.mintlify.com/docs/components/callouts.md): Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation.
- [Cards](https://www.mintlify.com/docs/components/cards.md): Use the Mintlify Card component to display links, icons, images, and grouped content as visual containers, including horizontal layouts and CardGroup grids.
- [Code groups](https://www.mintlify.com/docs/components/code-groups.md): Use the CodeGroup component to display multiple code examples in a tabbed interface and let readers compare implementations across languages.
- [Color](https://www.mintlify.com/docs/components/color.md): Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation.
- [Columns](https://www.mintlify.com/docs/components/columns.md): Arrange cards and other components in a responsive multi-column grid layout with the columns component, including customizable column counts.
- [Examples](https://www.mintlify.com/docs/components/examples.md): Display code examples in the right sidebar panel on desktop devices to show request and response samples alongside API documentation.
- [Expandables](https://www.mintlify.com/docs/components/expandables.md): Use the expandable component to toggle nested object properties in API documentation, showing child fields for request and response objects.
- [Fields](https://www.mintlify.com/docs/components/fields.md): Use ParamField and ResponseField components to document API request and response parameters with types, defaults, and validation rules.
- [Frames](https://www.mintlify.com/docs/components/frames.md): Wrap images, videos, and other components with the frame component to add styled borders, captions, and visual emphasis to your content.
- [Icons](https://www.mintlify.com/docs/components/icons.md): Add icons from Font Awesome, Lucide, Tabler, or custom sources to your documentation pages using the icon component with size and color options.
- [Components overview](https://www.mintlify.com/docs/components/index.md): Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages.
- [Mermaid](https://www.mintlify.com/docs/components/mermaid-diagrams.md): Create flowcharts, sequence diagrams, and other visualizations in your documentation using Mermaid syntax with automatic rendering.
- [Panel](https://www.mintlify.com/docs/components/panel.md): Customize the right side panel content on documentation pages to display supplementary information, examples, or navigation elements.
- [Prompt](https://www.mintlify.com/docs/components/prompt.md): Display pre-built AI prompts with one-click copy and Cursor integration buttons so users can quickly use prompts in their AI tools.
- [Response fields](https://www.mintlify.com/docs/components/responses.md): Document API response fields using the ResponseField component with type annotations, descriptions, and required or optional indicators.
- [Steps](https://www.mintlify.com/docs/components/steps.md): Create numbered step-by-step procedures with the steps component to guide users through sequential tasks, tutorials, and setup workflows.
- [Tabs](https://www.mintlify.com/docs/components/tabs.md): Use the tab component to organize content into switchable panels for showing different options, platform versions, or language examples.
- [Tiles](https://www.mintlify.com/docs/components/tiles.md): Use the tiles component to display visual previews with image thumbnails, titles, and descriptions in a responsive grid layout for your docs.
- [Tooltips](https://www.mintlify.com/docs/components/tooltips.md): Add tooltips to display contextual definitions and explanations when users hover over terms, abbreviations, or technical concepts in your documentation.
- [Tree](https://www.mintlify.com/docs/components/tree.md): Use the tree component to display hierarchical file and folder structures with collapsible nodes and syntax highlighting for path names.
- [Update](https://www.mintlify.com/docs/components/update.md): Use the update component to display product updates, release notes, and changelog entries in a structured timeline format with dates.
- [View](https://www.mintlify.com/docs/components/view.md): Use the view component to create switchable content panels for different programming languages, frameworks, or configuration alternatives.
- [Visibility](https://www.mintlify.com/docs/components/visibility.md): Use the visibility component to show different content to humans on the web UI and to AI agents in Markdown output for conditional rendering.
- [Changelogs](https://www.mintlify.com/docs/create/changelogs.md): Create product changelogs with date-based entries, RSS feed support, and subscriber notifications to keep users informed about updates.
- [Format code](https://www.mintlify.com/docs/create/code.md): Format code in your documentation with syntax highlighting, line numbers, diffs, copy buttons, and interactive code group features in MDX.
- [Files](https://www.mintlify.com/docs/create/files.md): Serve static assets like images, videos, PDFs, and data files from your documentation repository with automatic optimization and CDN delivery.
- [Images and embeds](https://www.mintlify.com/docs/create/image-embeds.md): Add images, embed YouTube videos, and include iframes in your MDX pages to enhance documentation with visual and interactive media content.
- [Lists and tables](https://www.mintlify.com/docs/create/list-table.md): Format structured data in your documentation with Markdown tables, ordered and unordered lists, nested structures, and task list checkboxes.
- [Personalized content](https://www.mintlify.com/docs/create/personalization.md): Show personalized content based on user authentication data, group memberships, and custom variables to tailor documentation per audience.
- [Redirects](https://www.mintlify.com/docs/create/redirects.md): Configure URL redirects in docs.json for moved, renamed, or deleted documentation pages to preserve SEO rankings and prevent broken links.
- [Reusable snippets](https://www.mintlify.com/docs/create/reusable-snippets.md): Create reusable content snippets with variables to maintain consistency across documentation pages and reduce duplication in your MDX files.
- [Format text](https://www.mintlify.com/docs/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://www.mintlify.com/docs/credits.md): Understand how Mintlify credits work for assistant messages, agent runs, and automations, including how we bill credit tiers, overages, and rollovers.
- [Custom 404 page](https://www.mintlify.com/docs/customize/custom-404-page.md): Customize the title, description, and appearance of your documentation site's 404 error page to match your brand and guide visitors.
- [Custom domain](https://www.mintlify.com/docs/customize/custom-domain.md): Host your site at your own domain, subdomain, or subpath with DNS records, automatic TLS certificates, and Mintlify-managed or proxy traffic routing.
- [Custom scripts](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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 components](https://www.mintlify.com/docs/customize/react-components.md): Build interactive and reusable elements with custom React components in your Mintlify documentation using JSX, state, and client-side logic.
- [Themes](https://www.mintlify.com/docs/customize/themes.md): Choose and configure a theme to customize your documentation site's colors, dark mode behavior, layout style, and overall visual appearance.
- [Audit logs](https://www.mintlify.com/docs/dashboard/audit-logs.md): Review audit logs to track actions performed by organization members, including deployments, configuration changes, and permission updates.
- [Dashboard access policies](https://www.mintlify.com/docs/dashboard/network-access.md): Restrict Mintlify dashboard access to trusted IP addresses and control how long dashboard sessions stay valid with idle timeouts and maximum session lifetimes.
- [Deployment permissions](https://www.mintlify.com/docs/dashboard/permissions.md): Understand deployment permission levels for organization members versus external contributors, including branch protection and merge access.
- [Roles](https://www.mintlify.com/docs/dashboard/roles.md): Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify.
- [SCIM user provisioning](https://www.mintlify.com/docs/dashboard/scim.md): Automatically provision, deprovision, and map users to roles for Mintlify dashboard members from Okta or another SCIM 2.0 identity provider.
- [Security contact](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/deploy/authentication-setup.md): Set up user authentication to control access to pages and API references using password, OAuth, JWT, or Mintlify-managed private access.
- [CI checks](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/deploy/deployments.md): Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting.
- [Host docs at a subpath](https://www.mintlify.com/docs/deploy/docs-subpath.md): Host your Mintlify documentation at a subpath like /docs on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy.
- [Offline export](https://www.mintlify.com/docs/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://www.mintlify.com/docs/deploy/ghes.md): Install and configure the Mintlify GitHub App on your GitHub Enterprise Server instance for automated documentation deployments and syncing.
- [GitHub](https://www.mintlify.com/docs/deploy/github.md): Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization.
- [GitLab](https://www.mintlify.com/docs/deploy/gitlab.md): Connect your GitLab repository to Mintlify for automated documentation deployments, merge request previews, and continuous synchronization.
- [Self-hosted GitLab OAuth](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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.
- [Deploy at a subpath with Vercel](https://www.mintlify.com/docs/deploy/vercel.md): Serve your Mintlify site at a subpath on your main domain using Vercel rewrites, with a step-by-step vercel.json configuration walkthrough.
- [External proxies with Vercel](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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.
- [Comment on pages in the editor](https://www.mintlify.com/docs/editor/comments.md): Leave inline comments on pages in the editor to give feedback, ask questions, mention teammates, and resolve threads before you publish changes.
- [Configurations](https://www.mintlify.com/docs/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.
- [Drafts](https://www.mintlify.com/docs/editor/drafts.md): Create isolated drafts in the editor that remain private until you request review and publish, without managing Git branches yourself.
- [Git essentials for the editor](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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.
- [Suggest changes in the editor](https://www.mintlify.com/docs/editor/suggestions.md): Propose text changes as suggestions that teammates can review, accept, or reject in the editor without modifying the current page content.
- [How to use the editor](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/index.md): Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search.
- [Adobe Analytics](https://www.mintlify.com/docs/integrations/analytics/adobe.md): Integrate Adobe Analytics with your Mintlify documentation site using Adobe Experience Platform Launch tags for detailed usage tracking.
- [Amplitude](https://www.mintlify.com/docs/integrations/analytics/amplitude.md): Integrate Amplitude analytics with your Mintlify documentation site to track user behavior, page views, and content engagement metrics.
- [Clarity](https://www.mintlify.com/docs/integrations/analytics/clarity.md): Integrate Microsoft Clarity with your Mintlify documentation site to capture session recordings, heatmaps, and user interaction analytics.
- [Clearbit](https://www.mintlify.com/docs/integrations/analytics/clearbit.md): Integrate Clearbit with your Mintlify documentation to enrich visitor data, identify visiting companies, and track enterprise engagement.
- [Fathom](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/integrations/analytics/heap.md): Integrate Heap analytics with your Mintlify documentation site to automatically capture user interactions and events for behavioral analysis.
- [Hightouch](https://www.mintlify.com/docs/integrations/analytics/hightouch.md): Integrate Hightouch with your Mintlify documentation to sync analytics data for audience activation, segmentation, and downstream tool routing.
- [Hotjar](https://www.mintlify.com/docs/integrations/analytics/hotjar.md): Integrate Hotjar with your Mintlify documentation site to capture session recordings, heatmaps, and user feedback for experience insights.
- [LogRocket](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/integrations/analytics/overview.md): Connect your Mintlify documentation to analytics platforms like Google Analytics, Mixpanel, PostHog, and more to track visitor engagement.
- [Pirsch](https://www.mintlify.com/docs/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://www.mintlify.com/docs/integrations/analytics/plausible.md): Integrate Plausible Analytics with your Mintlify documentation for lightweight, privacy-respecting visitor tracking without cookies or consent banners.
- [PostHog](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/integrations/privacy/osano.md): Integrate Osano with your Mintlify documentation site to manage cookie consent banners, privacy preferences, and regulatory compliance.
- [Privacy integrations](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/migration.md): Migrate your documentation to Mintlify from Docusaurus, ReadMe, GitBook, or another platform with step-by-step instructions and CLI tooling.
- [Analytics](https://www.mintlify.com/docs/optimize/analytics.md): Track traffic, search trends, assistant usage, and user feedback in the Mintlify analytics dashboard to improve content and report on effectiveness.
- [Feedback](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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.
- [Configure in-product search ranking, results, and filters](https://www.mintlify.com/docs/optimize/search.md): Configure the in-product search bar on your Mintlify docs site: ranking boosts, maximum results per query, and product and version search filters.
- [SEO](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/organize/pages.md): Configure page metadata, titles, descriptions, icons, and layout modes using YAML frontmatter properties at the top of your MDX documentation.
- [Related topics](https://www.mintlify.com/docs/organize/related-pages.md): Add links to related pages at the bottom of each page with automatic suggestions or manually curated links from frontmatter.
- [Global settings](https://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/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://www.mintlify.com/docs/what-is-mintlify.md): Mintlify is a documentation platform designed for developers and AI, with smart search, interactive API playgrounds, and built-in analytics.

## OpenAPI Specs

- [admin-openapi](https://www.mintlify.com/docs/admin-openapi.json)
- [static-export-openapi](https://www.mintlify.com/docs/static-export-openapi.json)
- [openapi](https://www.mintlify.com/docs/openapi.json)
- [discovery-openapi](https://www.mintlify.com/docs/discovery-openapi.json)
- [analytics.openapi](https://www.mintlify.com/docs/analytics.openapi.json)

## AsyncAPI Specs

- [asyncapi](https://www.mintlify.com/docs/asyncapi.yaml)