# 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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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.
- [Agent integrations](https://gwgwgw-api-refresh.mintlify.app/agent/integrations.md): Connect third-party apps so the agent can pull live context from Slack, Notion, Linear, Jira, and other tools when answering questions and updating content.
- [Add the agent to Slack](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/ai/contextual-menu.md): Add a contextual menu to your docs with one-click AI integrations for ChatGPT, Claude, Perplexity, Google AI Studio, Devin, Windsurf, and MCP tools.
- [llms.txt](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/ai/mintlify-mcp.md): Give AI tools like Claude 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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/api-playground/troubleshooting.md): Troubleshoot common issues with API playground configuration, including OpenAPI validation errors, missing endpoints, and auth problems.
- [Create agent job](https://gwgwgw-api-refresh.mintlify.app/api-reference/agent/create-agent-job.md): Create a background agent job. The job processes the prompt asynchronously — poll [Get agent job](#operation/getAgentJob) to track progress. If the agent edits files successfully, Mintlify creates a pull request and populates the `prLink` field.
- [Get agent job](https://gwgwgw-api-refresh.mintlify.app/api-reference/agent/get-agent-job.md): Get the current status and details of an agent job. Poll this endpoint to track job progress — the `status` field transitions from `active` to `completed`, `archived`, or `failed`.
- [Send follow-up message](https://gwgwgw-api-refresh.mintlify.app/api-reference/agent/send-follow-up-message.md): Send a follow-up instruction to an existing agent job. The message is processed asynchronously — poll [Get agent job](#operation/getAgentJob) to track progress.
- [Get assistant caller stats](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-assistant-caller-stats.md): Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range. Use this to understand whether queries come from your documentation site or from direct API integrations.
- [Get assistant conversations](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-assistant-conversations.md): Returns paginated AI assistant conversation history, including the user query, assistant response, sources cited, resolution status, and query category. Paginate using the `cursor` from each response while `hasMore` is `true`.
- [Get feedback by page](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-feedback-by-page.md): Returns feedback counts aggregated by documentation page path — thumbs up/down for contextual feedback, code snippet feedback count, and total per page.
- [Get page views](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-page-views.md): Returns per-path and site-wide content view event counts, split by human and AI traffic. Paginate using offset-based pagination: increment `offset` by `limit` while `hasMore` is `true`.
- [Get search queries](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-search-queries.md): Returns paginated documentation search terms ordered by hit count descending. Each row includes click-through rate, the most-clicked result path, and the last time the term was searched. `totalSearches` is the total search event count (sum of all hits, not distinct queries). Paginate using `nextCurs…
- [Get unique visitors](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-unique-visitors.md): Returns per-path and site-wide approximate distinct visitors split by human and AI traffic. The `total` field is deduplicated across human and AI (union of distinct visitor IDs). Paginate using offset-based pagination: increment `offset` by `limit` while `hasMore` is `true`.
- [Get user feedback](https://gwgwgw-api-refresh.mintlify.app/api-reference/analytics/get-user-feedback.md): Returns paginated user feedback with optional filtering. Paginate using the `cursor` from each response while `hasMore` is `true`.
- [Get update status](https://gwgwgw-api-refresh.mintlify.app/api-reference/deployments/get-update-status.md): Get the status and details of a documentation update by its status ID.
- [Trigger preview deployment](https://gwgwgw-api-refresh.mintlify.app/api-reference/deployments/trigger-preview-deployment.md): Create or update a preview deployment for a specific Git branch. If a preview already exists for the branch, it triggers a redeployment instead of creating a duplicate. Returns a status ID and the preview URL.
- [Trigger update](https://gwgwgw-api-refresh.mintlify.app/api-reference/deployments/trigger-update.md): Queue a deployment update for your documentation project. Returns a status ID that you can use with [Get update status](#operation/getUpdateStatus) to track progress. The update deploys from your configured deployment branch.
- [Assistant message (AI SDK v4)](https://gwgwgw-api-refresh.mintlify.app/api/assistant/create-assistant-message.md): Generates a streaming assistant response for the specified domain. Compatible with AI SDK v4. If you are using AI SDK v5 or later, use the [v2 endpoint](/api/assistant/create-assistant-message-v2) instead.
- [Assistant message (AI SDK v5+)](https://gwgwgw-api-refresh.mintlify.app/api/assistant/create-assistant-message-v2.md): Generates a streaming assistant response for the specified domain. Compatible with AI SDK v5+. If you are using AI SDK v4, use the [v1 endpoint](/api/assistant/create-assistant-message) instead.
- [Get page content](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/api/assistant/search.md): Perform semantic and keyword searches across your documentation with configurable filtering and pagination.
- [Mintlify REST API](https://gwgwgw-api-refresh.mintlify.app/api/introduction.md): Programmatically trigger deployments, embed an AI assistant, export analytics, and automate documentation edits.
- [Configure the assistant](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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.
- [Use the assistant](https://gwgwgw-api-refresh.mintlify.app/assistant/use.md): Open the assistant with keyboard shortcuts, highlighted text, code blocks, file attachments, or URL parameters. Test assistant behavior in local preview.
- [Analyze your documentation](https://gwgwgw-api-refresh.mintlify.app/cli/analytics.md): Use the mint analytics command to view traffic, search queries, user feedback, and AI assistant conversations directly from your terminal.
- [Commands](https://gwgwgw-api-refresh.mintlify.app/cli/commands.md): Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint analytics, and more.
- [Mintlify CLI](https://gwgwgw-api-refresh.mintlify.app/cli/index.md): Use the Mintlify CLI to preview docs locally, test changes in real time, analyze site performance, and run quality checks before deploying.
- [Install the CLI](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/badge.md): Use the badge component to highlight status indicators, version labels, or metadata inline with customizable colors and hover tooltips.
- [Banner](https://gwgwgw-api-refresh.mintlify.app/components/banner.md): Add a dismissible banner at the top of your documentation site to display important announcements, release notes, or notifications.
- [Callouts](https://gwgwgw-api-refresh.mintlify.app/components/callouts.md): Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation.
- [Cards](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/fields.md): Use ParamField and ResponseField components to document API request and response parameters with types, defaults, and validation rules.
- [Frames](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/index.md): Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages.
- [Mermaid](https://gwgwgw-api-refresh.mintlify.app/components/mermaid-diagrams.md): Create flowcharts, sequence diagrams, and other visualizations in your documentation using Mermaid syntax with automatic rendering.
- [Panel](https://gwgwgw-api-refresh.mintlify.app/components/panel.md): Customize the right side panel content on documentation pages to display supplementary information, examples, or navigation elements.
- [Prompt](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/responses.md): Document API response fields using the ResponseField component with type annotations, descriptions, and required or optional indicators.
- [Steps](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/tabs.md): Use the tab component to organize content into switchable panels for showing different options, platform versions, or language examples.
- [Tiles](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/components/view.md): Use the view component to create switchable content panels for different programming languages, frameworks, or configuration alternatives.
- [Visibility](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/create/personalization.md): Show personalized content based on user authentication data, group memberships, and custom variables to tailor documentation per audience.
- [Redirects](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/credits.md): Understand how Mintlify credits work for assistant messages, agent runs, and workflows. How credit tiers, overages, and rollovers are billed.
- [Custom 404 page](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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.
- [Themes](https://gwgwgw-api-refresh.mintlify.app/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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/dashboard/permissions.md): Understand deployment permission levels for organization members versus external contributors, including branch protection and merge access.
- [Roles](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/deploy/authentication-setup.md): Configure user authentication for your site with OAuth, JWT, password, or shared links to control access to pages and API references.
- [CI checks](https://gwgwgw-api-refresh.mintlify.app/deploy/ci.md): Automate documentation quality checks in your CI/CD pipeline with broken link detection, linting, grammar validation, and build previews.
- [Cloudflare](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/deploy/github.md): Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization.
- [GitLab](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/deploy/gitlab-self-hosted.md): Connect a self-hosted GitLab instance to Mintlify via OAuth so workflows can clone repositories, push commits, and open merge requests on your behalf.
- [Monorepo setup](https://gwgwgw-api-refresh.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.
- [Preview deployments](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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.
- [Branching and publishing](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/editor/configurations.md): Edit site branding, colors, appearance, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync.
- [Editor overview](https://gwgwgw-api-refresh.mintlify.app/editor/index.md): Create, edit, and publish documentation in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync.
- [Keyboard shortcuts](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/editor/live-preview.md): Preview your documentation site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly.
- [Organize navigation](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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 docs.
- [Editor settings for AI and publishing](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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 documentation changes.
- [How to create accessible documentation](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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.
- [Configure automerge for GitHub Apps](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.mintlify.app/guides/developer-documentation.md): Build developer documentation that helps engineers integrate with your APIs, SDKs, and tools, including quickstarts, references, and guides.
- [GEO guide: Optimize docs for AI search and answer engines](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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 workflows](https://gwgwgw-api-refresh.mintlify.app/guides/use-workflows.md): Use Mintlify workflows to automate recurring docs maintenance: choose the right trigger, write effective instructions, and get consistent agent results.
- [Write documentation with Windsurf](https://gwgwgw-api-refresh.mintlify.app/guides/windsurf.md): Configure Windsurf Cascade with workspace rules and memories to write Mintlify documentation that follows your style guide and MDX standards.
- [Introduction](https://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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://gwgwgw-api-refresh.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.
- [Create a custom workflow](https://gwgwgw-api-refresh.mintlify.app/workflows/create.md): Create a custom Mintlify workflow with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks.
- [Workflows overview](https://gwgwgw-api-refresh.mintlify.app/workflows/index.md): Automate content maintenance with Mintlify workflows. Run the agent on a schedule or in response to GitHub and GitLab repository pushes.
- [Manage workflows](https://gwgwgw-api-refresh.mintlify.app/workflows/manage.md): Enable, disable, trigger, and delete workflows from your dashboard. Configure GitHub or GitLab triggers, schedules, context repos, and automerge.
- [Predefined workflows](https://gwgwgw-api-refresh.mintlify.app/workflows/reference.md): Reference for all predefined Mintlify workflows, including default trigger, update mode, context repository support, and required configurations.

## OpenAPI Specs

- [openapi](https://gwgwgw-api-refresh.mintlify.app/zh/openapi.json)
- [discovery-openapi](https://gwgwgw-api-refresh.mintlify.app/discovery-openapi.json)
- [analytics.openapi](https://gwgwgw-api-refresh.mintlify.app/analytics.openapi.json)
- [admin-openapi](https://gwgwgw-api-refresh.mintlify.app/admin-openapi.json)