# 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. ## Get started - [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. - [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. - [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 Model Context Protocol (MCP) server. ## CLI - [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. - [Mintlify CLI command reference](https://www.mintlify.com/docs/cli/commands.md): Complete reference for Mintlify CLI commands and flags, including mint index, mint dev, mint validate, mint broken-links, and more. ## Migrate to Mintlify - [Migration overview](https://www.mintlify.com/docs/migration/index.md): Choose a migration path for moving existing documentation from Docusaurus, ReadMe, GitBook, Fern, Document360, or another platform to Mintlify. - [Migrate from Docusaurus](https://www.mintlify.com/docs/migration/docusaurus.md): Migrate Docusaurus documentation to Mintlify, including MDX pages, sidebars, versions, localized content, assets, and custom components. - [Migrate from ReadMe](https://www.mintlify.com/docs/migration/readme.md): Migrate ReadMe guides, API references, recipes, custom pages, versions, reusable content, and assets to Mintlify with the scraper or a project export. - [Migrate from GitBook](https://www.mintlify.com/docs/migration/gitbook.md): Migrate GitBook sections, Markdown, navigation, reusable content, variants, assets, and OpenAPI documentation to Mintlify using Git Sync or the scraper. - [Migrate from Fern](https://www.mintlify.com/docs/migration/fern.md): Migrate a Fern to Mintlify. Convert MDX content, docs.yml navigation, products, versions, assets, API references, and components. - [Migrate from Document360](https://www.mintlify.com/docs/migration/document360.md): Export a Document360 project ZIP and migrate its workspaces, languages, articles, categories, media, reusable content, and API references to Mintlify. - [Migrate from another platform](https://www.mintlify.com/docs/migration/manual.md): Convert documentation from any source platform to Mintlify pages, navigation, components, API references, assets, and redirects. ## Pages - [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. - [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. - [Related topics](https://www.mintlify.com/docs/organize/related-pages.md): Add a related topics section at the bottom of each page using automatic recommendations or manually curated links defined in page frontmatter. ## Formatting - [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. - [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. - [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. ## Components - [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. - [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. - [GitHub](https://www.mintlify.com/docs/components/github.md): Use the GitHub component to embed a public repository card with a live description, star count, and fork count on any documentation page. - [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. - [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. - [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. ## Media - [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. - [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. ## Create content - [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. - [Personalized content](https://www.mintlify.com/docs/create/personalization.md): Show personalized content based on identified visitor data, group memberships, and custom variables to tailor documentation per audience. ## Editor - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [Ask agent](https://www.mintlify.com/docs/editor/agent.md): Use the editor's built-in AI agent to write content, edit pages, leave comments and suggestions, search your site, upload files, and configure settings. - [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. - [Editor settings for AI and publishing](https://www.mintlify.com/docs/editor/settings.md): Configure AI instructions, pull request defaults, and the default merge method to control how the Mintlify web editor publishes changes. - [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. ## Create content - [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. ## Global settings - [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. - [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. - [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. - [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. - [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. - [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. - [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. ## Manage your site - [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. - [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. - [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. - [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. ## Repository setup - [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. ## Visual customization - [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. - [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. - [Custom scripts](https://www.mintlify.com/docs/customize/custom-scripts.md): Add custom JavaScript and CSS for analytics, widgets, styling, third-party integrations, and API playground server variables on your documentation site. - [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. ## Analytics - [Analytics overview](https://www.mintlify.com/docs/analytics/index.md): Explore the Mintlify analytics dashboard to measure documentation traffic, assistant conversations, search queries, engagement, and reader feedback. - [Analyze documentation traffic](https://www.mintlify.com/docs/analytics/traffic.md): Review traffic analytics to track visitors, page views, referrals, popular pages, and traffic from both human readers and AI agents. - [Analyze assistant conversations](https://www.mintlify.com/docs/analytics/assistant.md): Review assistant analytics in the Mintlify dashboard to explore conversation categories, topics, satisfaction, chat history, and content gaps. - [Analyze documentation searches](https://www.mintlify.com/docs/analytics/search.md): Review documentation search analytics to track query volume, spot searches returning no results, and improve result click-through rates. - [Analyze user engagements](https://www.mintlify.com/docs/analytics/user-engagements.md): Use engagement analytics to measure content actions, CTA click-through rates, user flows through your docs, and search and assistant funnels. - [Collect page feedback from users and AI agents](https://www.mintlify.com/docs/optimize/feedback.md): Enable feedback widgets, page ratings, contextual notes, code snippet reactions, and agent feedback to find and fix documentation gaps. - [Export analytics to CSV](https://www.mintlify.com/docs/analytics/export.md): Export traffic, referrals, assistant, search, and feedback analytics to CSV from your Mintlify dashboard and interpret each export field. - [Stream analytics events to Amazon S3](https://www.mintlify.com/docs/analytics/streaming.md): Configure Enterprise analytics streaming to send selected event categories from your Mintlify deployments to Amazon S3 in near real time. ## Deployments - [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. - [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. - [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. - [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. - [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. - [Bitbucket Cloud](https://www.mintlify.com/docs/deploy/bitbucket.md): Connect a Bitbucket Cloud repository to Mintlify for automatic deployments, pull request previews, and continuous synchronization. ## Hosting - [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. ## Subpath hosting - [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. - [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. - [Deploy at a subpath with AWS Route 53 and CloudFront](https://www.mintlify.com/docs/deploy/route53-cloudfront.md): Deploy your Mintlify documentation at a subpath on AWS by combining Route 53 DNS routing, a CloudFront distribution, and cache behaviors. - [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. - [Reverse proxy](https://www.mintlify.com/docs/deploy/reverse-proxy.md): Configure a custom reverse proxy with nginx or a similar tool to serve your Mintlify documentation at a subpath on your own domain. ## Hosting - [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. - [Self-host](https://www.mintlify.com/docs/deploy/self-host.md): Run Mintlify inside your own cloud or on-premises environment, on AWS or any Kubernetes platform including Azure, Google Cloud, Oracle Cloud, and OpenShift. - [Custom developer portals](https://www.mintlify.com/docs/deploy/custom-portal.md): Deploy a fully custom developer portal on top of self-hosted Mintlify, designed and built by Mintlify and delivered through versioned releases. ## Export your site - [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. - [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. ## 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. - [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. - [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. - [Session security](https://www.mintlify.com/docs/dashboard/session-security.md): Configure dashboard session timeouts, maximum session lifetime, and an IP allowlist to enforce stricter authentication and network access policies. ## Security - [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. - [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. - [Audit logs](https://www.mintlify.com/docs/dashboard/audit-logs.md): Review, export, and stream audit logs to Amazon S3 or Datadog to track deployments, configuration changes, and permission updates in your organization. - [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. ## Agent - [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. ## Automations - [Automations overview](https://www.mintlify.com/docs/automations/index.md): Automate content maintenance with Mintlify automations by running the agent on a schedule, on repository pushes, or on connected integration events. - [Create a custom automation](https://www.mintlify.com/docs/automations/create.md): Create a Mintlify automation that runs on a schedule, repository push, or integration event. Add context repositories and a custom agent prompt. - [Manage automations](https://www.mintlify.com/docs/automations/manage.md): Enable, disable, trigger, and delete automations from your dashboard. Configure repository, schedule, and integration triggers; context repos; and automerge. - [Integrations for the agent and automations](https://www.mintlify.com/docs/automations/integrations.md): Connect third-party apps so the Mintlify agent can use live context in Slack, during automation runs, or as a trigger for custom automations. - [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. - [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. ## Agent - [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. - [Mintlify agent use cases and examples](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. ## Assistant - [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. - [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. - [Embed the AI assistant widget](https://www.mintlify.com/docs/assistant/widget.md): Install and configure the Mintlify widget to embed an AI assistant trained on your content into any website, web app, or dashboard. - [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. ## Agent-ready content - [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. ## Mintlify Index - [Index](https://www.mintlify.com/docs/search-index/index.md): Give coding agents current technical context from publisher-maintained documentation and the web through one MCP server or REST API. - [Connect Mintlify Index to your coding agent](https://www.mintlify.com/docs/search-index/connect.md): Set up the Mintlify Index MCP server in Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, or Zed with the CLI or manual configuration. - [Mintlify Index MCP server](https://www.mintlify.com/docs/search-index/mcp.md): Reference for the public Mintlify Index MCP server: connection URL, the context tool, parameters, response format, rate limits, and usage examples. ## Agent-ready content - [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. - [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. - [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. - [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. ## Search and SEO - [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. ## Document APIs - [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. ## API specifications - [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. - [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. - [GraphQL setup](https://www.mintlify.com/docs/api-playground/graphql-setup.md): Generate reference pages for your GraphQL API from a schema definition file, with linked types and example queries, mutations, and responses. ## SDK reference setup - [Generate SDK reference pages from doc-tool output](https://www.mintlify.com/docs/api-playground/sdk-reference-setup.md): Publish SDK reference documentation in Mintlify from TypeDoc, DocFX, Javadoc, Sphinx, or phpDocumentor artifacts using the sdk navigation property. - [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. ## Endpoint 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. - [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. - [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. ## Document APIs - [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. ## Analytics - [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. - [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. - [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. ## SDKs - [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. ## Support - [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. - [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. - [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. ## Privacy - [Privacy integrations](https://www.mintlify.com/docs/integrations/privacy/overview.md): Connect your Mintlify documentation site to privacy platforms like Osano and Transcend to manage cookie consent, compliance banners, and user preferences. - [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. - [Transcend](https://www.mintlify.com/docs/integrations/privacy/transcend.md): Integrate Transcend Consent Management with your Mintlify docs to gate analytics behind visitor consent using your existing Transcend bundle. ## Reference - [Concepts](https://www.mintlify.com/docs/reference/concepts.md): Learn how Mintlify connects your organization, documentation repository, editing workflows, previews, deployments, analytics, and AI features. - [Glossary](https://www.mintlify.com/docs/reference/glossary.md): Definitions for Mintlify product, content, navigation, deployment, Git, API playground, and AI terminology used throughout the documentation. - [Credit pricing](https://www.mintlify.com/docs/credits.md): Understand how your organization's credit balance works, what consumes credits, and how we bill credit add-ons, overages, and rollovers. ## API reference - [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. ## Admin - [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. - [Get deployment status](https://www.mintlify.com/docs/api/update/status.md): Get the status of an update from the status ID - [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. - [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… ## Agent - [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. ## Assistant - [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+. ## Search - [Search documentation](https://www.mintlify.com/docs/api/assistant/search.md): Perform semantic and keyword searches across your documentation with configurable filtering and pagination. - [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. ## Mintlify Index - [Mintlify Index REST API](https://www.mintlify.com/docs/api/search-index/introduction.md): Use the Mintlify Index REST API to search documentation and the web, assemble source-cited context, and retrieve page contents for applications and agents. - [Build implementation context](https://www.mintlify.com/docs/api/search-index/context.md): Searches Mintlify Index and returns source-cited content assembled within a token budget. Use this endpoint when an application or agent needs ready-to-use context in one request. - [Search technical knowledge](https://www.mintlify.com/docs/api/search-index/search.md): Returns ranked results from publisher-maintained documentation or the web. Use Mintlify result IDs or any result URL with the contents endpoint when you need more content. - [Get result contents](https://www.mintlify.com/docs/api/search-index/contents.md): Retrieves content for Mintlify result IDs or result URLs returned by the search endpoint. A request can include up to 20 items across both fields. ## Analytics - [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 assistant conversations](https://www.mintlify.com/docs/api/analytics/assistant-conversations.md): Returns paginated AI assistant conversation history - [Get assistant conversation thread](https://www.mintlify.com/docs/api/analytics/assistant-thread.md): Returns the full message transcript for a single assistant conversation thread. The thread ID is available from the assistant conversations endpoint, or as the `threadId` query parameter appended to assistant link-mode deflection support URLs. - [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 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). ## Static export - [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 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`). - [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`. ## Help center - [Fix "Failed to fetch OpenAPI file for anchor or tab" error](https://www.mintlify.com/docs/help-center/openapi-url-fetch-fails-during-build.md): Fix Mintlify builds that fail to download a hosted OpenAPI document because of private hosts, authenticated URLs, TLS, DNS, or CI race conditions. - [Fix "Domain already claimed by another organization" error](https://www.mintlify.com/docs/help-center/domain-already-claimed-by-another-organization.md): Release a custom domain from another Mintlify deployment or request help when adding it fails because another deployment or organization already holds it. - [Configure OAuth 2.0 authentication with Auth0](https://www.mintlify.com/docs/help-center/configure-oauth-with-auth0.md): Set up Auth0 as the OAuth 2.0 identity provider for a private Mintlify docs site: endpoint URLs, callback registration, and group-based access. - [Private repo missing when creating a second deployment](https://www.mintlify.com/docs/help-center/private-repo-missing-when-creating-second-deployment.md): Re-authorize Mintlify with private-repo access so an existing private GitHub repository shows up in the onboarding repo picker for a new deployment. - [Fix a static file that returns 404 on your docs site](https://www.mintlify.com/docs/help-center/static-file-not-served.md): Diagnose why a file you added to your documentation repository (like a JSON, PDF, or image) does not load at its expected URL on your Mintlify site. ## Overview - [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. ## AI - [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. - [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. - [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. - [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. - [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. - [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. ## API docs - [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. ## Best practices - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. - [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. ## Git - [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. - [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. ## Use cases - [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. - [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. - [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. - [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. - [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. - [fr](https://www.mintlify.com/docs/_llms/fr.md) - [es](https://www.mintlify.com/docs/_llms/es.md) ## 快速入门 - [简介](https://www.mintlify.com/docs/zh/index.md): 邂逅新一代文档体验：AI 原生、开箱即用且美观，为开发者打造。 - [快速入门](https://www.mintlify.com/docs/zh/quickstart.md): 按照快速入门指南部署 Mintlify 文档站点，连接 GitHub 或使用 Web 编辑器，完成首次内容修改，并通过 CLI 预览、验证和发布更新，同时为用户或 AI 智能体配置完整工作流。本文涵盖账号设置、仓库连接、域名访问、本地开发、页面编辑、部署检查和后续自定义步骤，帮助你快速开始维护线上文档。 - [AI 原生文档](https://www.mintlify.com/docs/zh/ai-native.md): 了解 AI 原生功能如何通过助手、agent 和 MCP 服务器提升文档的阅读、创作和发现体验。 ## CLI - [Mintlify CLI](https://www.mintlify.com/docs/zh/cli/index.md): 使用 Mintlify CLI 在本地预览和编辑文档，实时查看内容变更，运行断链、无障碍和构建验证检查，评估 agent 就绪度，格式化 MDX 文件，并在部署前发现问题。了解 CLI 如何连接 Mintlify 部署、启用本地搜索和 AI 助手，以及如何管理文档子域名和后续开发流程。 - [安装 CLI](https://www.mintlify.com/docs/zh/cli/install.md): 安装 Mintlify CLI 并配置本地文档开发环境，使用 npm 或 pnpm 管理全局安装，创建新项目、更新 CLI、格式化 MDX 文件，以及在发布前排查权限和构建问题。本文还说明 Node.js 版本要求、主题与模板选项、常用命令、交互式设置方式，以及本地预览异常和客户端下载失败时的处理方法。 - [本地预览](https://www.mintlify.com/docs/zh/cli/preview.md): 使用 mint dev 运行 Mintlify 文档站点的本地预览，支持实时重载、全文搜索和 AI 助手。 - [Mintlify CLI 命令参考](https://www.mintlify.com/docs/zh/cli/commands.md): Mintlify CLI 所有命令和选项的完整参考，涵盖 mint index、mint dev、mint validate 和 mint broken-links，并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流，帮助你完成日常文档开发以及部署前检查。 ## 迁移到 Mintlify - [迁移概览](https://www.mintlify.com/docs/zh/migration/index.md): 为将现有文档从 Docusaurus、ReadMe、GitBook、Fern、Document360 或其他平台迁移到 Mintlify 选择合适的迁移路径。 - [从 Docusaurus 迁移](https://www.mintlify.com/docs/zh/migration/docusaurus.md): 将 Docusaurus 文档迁移到 Mintlify，包括 MDX 页面、侧边栏、版本、本地化内容、资源和自定义组件。 - [从 ReadMe 迁移](https://www.mintlify.com/docs/zh/migration/readme.md): 将 ReadMe 指南、API 参考、recipes、自定义页面、版本、可复用内容和资源迁移到 Mintlify。 - [从 GitBook 迁移](https://www.mintlify.com/docs/zh/migration/gitbook.md): 将 GitBook 的 sections、Markdown、导航、可复用内容、variants、资源和 OpenAPI 文档迁移到 Mintlify。 - [从 Fern 迁移](https://www.mintlify.com/docs/zh/migration/fern.md): 将 Fern 的 MDX 内容、docs.yml 导航、products、versions、资源、API 参考和组件迁移到 Mintlify。 - [从 Document360 迁移](https://www.mintlify.com/docs/zh/migration/document360.md): 将 Document360 的工作区、语言、文章、分类、媒体、可复用内容和 API 参考迁移到 Mintlify。 - [从其他平台迁移](https://www.mintlify.com/docs/zh/migration/manual.md): 将文档从任意平台转换为 Mintlify 的页面、导航、组件、API 参考、资源和重定向。 ## 页面 - [页面](https://www.mintlify.com/docs/zh/organize/pages.md): 使用 MDX 文件顶部的 YAML frontmatter 配置页面标题、描述、侧边栏、图标、标签、搜索与 SEO 元数据，并了解页面布局模式、API 页面、外部链接和时间戳设置。本文完整介绍隐藏、索引、可搜索性、搜索加权、相关页面、访问组和上下文菜单等字段，帮助你为文档页面选择合适的布局与行为。 - [隐藏页面](https://www.mintlify.com/docs/zh/organize/hidden-pages.md): 将文档页面从侧边栏导航中隐藏，同时仍可通过直接 URL、站内搜索或 AI 助手访问，适用于内部参考、AI 上下文等特殊场景。 - [相关页面](https://www.mintlify.com/docs/zh/organize/related-pages.md): 使用自动推荐或在页面 frontmatter 中手动整理的链接，在每个页面底部添加“相关主题”版块。 ## 格式设置 - [文本格式](https://www.mintlify.com/docs/zh/create/text.md): 在 MDX 页面中使用 Markdown 标题、粗体、斜体、链接、引用块和其他内联样式选项格式化文档文本。 - [格式化代码](https://www.mintlify.com/docs/zh/create/code.md): 在文档中格式化代码，支持语法高亮、行号、差异对比、复制按钮和 MDX 中的交互式代码组功能。 - [列表与表格](https://www.mintlify.com/docs/zh/create/list-table.md): 使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。 ## 组件 - [概览](https://www.mintlify.com/docs/zh/components/index.md): 浏览 Mintlify 完整组件库，包含适用于 MDX 页面的布局、强调、API 文档和导航元素组件。 - [折叠面板](https://www.mintlify.com/docs/zh/components/accordions.md): 使用折叠面板组件在文档中显示和隐藏内容区块、组织相关信息，并实现渐进式信息披露。 - [徽章](https://www.mintlify.com/docs/zh/components/badge.md): 使用徽章组件高亮显示状态指示器、版本标签或内联元数据，支持自定义颜色和悬停提示。 - [横幅](https://www.mintlify.com/docs/zh/components/banner.md): 在文档站点顶部添加可关闭的横幅，用于显示重要公告、发行说明或通知。 - [标注框](https://www.mintlify.com/docs/zh/components/callouts.md): 添加 info、note、tip、check、warning、danger 和自定义标注框组件，在文档中突出显示重要信息。 - [卡片](https://www.mintlify.com/docs/zh/components/cards.md): 使用卡片组件以可视化容器的形式展示链接、图标、图片和分组内容，从而组织导航。 - [代码分组](https://www.mintlify.com/docs/zh/components/code-groups.md): 使用 CodeGroup 组件在标签页界面中展示多个代码示例，让读者可以比较不同编程语言的实现方式。 - [颜色](https://www.mintlify.com/docs/zh/components/color.md): 使用颜色组件展示带有十六进制值和点击复制功能的色板，适用于设计系统和品牌规范文档。 - [列](https://www.mintlify.com/docs/zh/components/columns.md): 使用 columns 组件将卡片和其他组件排列在响应式多列网格布局中，支持自定义列数。 - [示例](https://www.mintlify.com/docs/zh/components/examples.md): 在桌面设备右侧边栏面板中展示代码示例，与 API 文档并排显示请求和响应样本。 - [可展开项](https://www.mintlify.com/docs/zh/components/expandables.md): 使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。 - [字段](https://www.mintlify.com/docs/zh/components/fields.md): 使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。 - [Frames](https://www.mintlify.com/docs/zh/components/frames.md): 使用 frame 组件为图片、视频和其他内容添加样式化边框、说明文字和视觉强调效果。 - [GitHub](https://www.mintlify.com/docs/zh/components/github.md): 使用 GitHub 组件在文档中嵌入仓库卡片，实时显示仓库的描述、star 数量和 fork 数量。 - [图标](https://www.mintlify.com/docs/zh/components/icons.md): 使用图标组件将 Font Awesome、Lucide、Tabler 或自定义来源的图标添加到文档页面，支持尺寸和颜色选项。 - [Mermaid](https://www.mintlify.com/docs/zh/components/mermaid-diagrams.md): 使用 Mermaid 语法在文档中创建流程图、序列图和其他可视化图表，并自动渲染。 - [Panel](https://www.mintlify.com/docs/zh/components/panel.md): 自定义文档页面右侧面板的内容，用于显示补充信息、示例或导航元素。 - [提示](https://www.mintlify.com/docs/zh/components/prompt.md): 展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。 - [响应字段](https://www.mintlify.com/docs/zh/components/responses.md): 使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。 - [步骤](https://www.mintlify.com/docs/zh/components/steps.md): 使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。 - [选项卡](https://www.mintlify.com/docs/zh/components/tabs.md): 使用 tab 组件将内容组织成可切换的面板，用于展示不同选项、平台版本或语言示例。 - [磁贴](https://www.mintlify.com/docs/zh/components/tiles.md): 使用 tiles 组件在响应式网格布局中展示带有图片缩略图、标题和描述的视觉预览。 - [工具提示](https://www.mintlify.com/docs/zh/components/tooltips.md): 添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。 - [树](https://www.mintlify.com/docs/zh/components/tree.md): 使用树组件显示带有可折叠节点和路径名语法高亮的层级文件与文件夹结构。 - [Update](https://www.mintlify.com/docs/zh/components/update.md): 使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。 - [视图](https://www.mintlify.com/docs/zh/components/view.md): 使用 view 组件为不同编程语言、框架或配置方案创建可切换的内容面板。 - [Visibility](https://www.mintlify.com/docs/zh/components/visibility.md): 使用 visibility 组件向网页界面上的人类用户和 Markdown 输出中的 AI 代理展示不同内容，实现条件渲染。 - [React](https://www.mintlify.com/docs/zh/customize/react-components.md): 使用 JSX、状态和客户端逻辑，在你的 Mintlify 文档中通过自定义 React 组件构建交互且可复用的元素。 ## 媒体 - [图片与嵌入](https://www.mintlify.com/docs/zh/create/image-embeds.md): 在 MDX 页面中添加图片、嵌入 YouTube 视频和 iframe，以视觉和互动内容丰富文档。 - [文件](https://www.mintlify.com/docs/zh/create/files.md): 从你的文档仓库提供图片、视频、PDF 和数据文件等静态资产，支持自动优化和 CDN 分发。 ## 创建内容 - [可复用片段](https://www.mintlify.com/docs/zh/create/reusable-snippets.md): 创建带有变量的可复用内容片段，在文档页面间保持一致性并减少 MDX 文件中的重复内容。 - [个性化内容](https://www.mintlify.com/docs/zh/create/personalization.md): 根据已识别访客的数据、用户组成员资格和自定义变量显示个性化内容，为不同受众量身定制文档。 ## Web 编辑器 - [编辑器概览](https://www.mintlify.com/docs/zh/editor/index.md): 在浏览器中创建、编辑和发布文档，支持团队实时协作、自动保存、实时预览以及与 Git 持续同步。 - [如何使用编辑器](https://www.mintlify.com/docs/zh/editor/tutorial.md): Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审查，然后发布你的更改。 - [编辑器中的 Git 基础](https://www.mintlify.com/docs/zh/editor/git-essentials.md): 了解 Mintlify 编辑器背后的 Git 版本控制概念，包括 branch、commit、拉取请求和合并工作流。 - [创建和编辑页面](https://www.mintlify.com/docs/zh/editor/pages.md): 在 Mintlify Web 编辑器中创建和编辑文档页面，管理文件与文件夹，使用可视化或 Markdown 模式编辑内容，配置页面设置，插入图片、视频和外部媒体。了解如何搜索文件、管理未列出的页面、调整导航顺序、设置页面标题、Slug、描述和布局，以及使用版本历史查看页面保存记录。 - [组织导航](https://www.mintlify.com/docs/zh/editor/navigation.md): 通过在 Mintlify Web 编辑器中拖放，重新排序页面、添加分组并管理文档侧边栏结构，无需修改 docs.json。 - [实时预览](https://www.mintlify.com/docs/zh/editor/live-preview.md): 在编辑时实时预览你的文档站点，持续查看内容、导航和站点配置的更改；了解如何在编辑器或新标签页中打开实时预览，并使用 Site settings 检查器调整配置、查看渲染结果、比较预览部署，以及在发布前检查更改。适合在编辑过程中获得即时反馈，帮助你在共享预览前验证页面显示效果和站点设置是否符合预期。 - [分支与发布](https://www.mintlify.com/docs/zh/editor/branching-and-publishing.md): 了解分支及保护规则如何决定发布时所发生的操作，以及如何管理完整的审查与部署工作流。 - [评论](https://www.mintlify.com/docs/zh/editor/comments.md): 在编辑器中对页面留下行内评论，与团队成员反馈意见、提出问题并讨论更改。 - [Mintlify 内容编辑器中的文本建议和协作审阅指南](https://www.mintlify.com/docs/zh/editor/suggestions.md): 了解如何在 Mintlify 内容编辑器中使用建议模式提出文本更改，查看高亮的待处理建议，并让团队成员审阅、接受或拒绝更改，同时保留当前页面内容不变。查看编辑者、管理员和查看者在建议模式中的权限，以及如何退出建议模式。适用于需要在发布前协作审阅文档内容的团队。 - [向代理提问](https://www.mintlify.com/docs/zh/editor/agent.md): 使用编辑器内置的 AI 代理撰写内容、编辑页面、留下评论和建议、跨站点搜索、上传文件并配置设置。 - [配置](https://www.mintlify.com/docs/zh/editor/configurations.md): 使用 Mintlify 网页编辑器侧边栏中的可视化配置表单编辑页面元数据、导航元素和媒体设置。 - [用于 AI 与发布的编辑器设置](https://www.mintlify.com/docs/zh/editor/settings.md): 配置 AI 指令、pull request 默认值以及默认合并方式，以控制 Mintlify Web 编辑器发布变更的方式。 - [键盘快捷键](https://www.mintlify.com/docs/zh/editor/keyboard-shortcuts.md): 查看 Mintlify 网页编辑器的完整键盘快捷键列表，包括文本格式、导航和编辑命令。 ## 创建内容 - [CI 检查](https://www.mintlify.com/docs/zh/deploy/ci.md): 在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。 ## 全局设置 - [全局设置](https://www.mintlify.com/docs/zh/organize/settings.md): 使用 docs.json 配置你的 Mintlify 文档站点，该文件控制导航、外观和集成。 - [外观与品牌](https://www.mintlify.com/docs/zh/organize/settings-appearance.md): 在 docs.json 中配置主题、颜色、logo、favicon、字体和背景。 - [站点结构](https://www.mintlify.com/docs/zh/organize/settings-structure.md): 在 docs.json 中配置导航栏、页脚、横幅、重定向和其他结构设置。 - [API 设置](https://www.mintlify.com/docs/zh/organize/settings-api.md): 在 docs.json 文件中配置 OpenAPI 和 AsyncAPI 规范、交互式 API 演练场、SDK 代码示例和身份验证设置。 - [集成](https://www.mintlify.com/docs/zh/organize/settings-integrations.md): 通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。 - [SEO 和搜索](https://www.mintlify.com/docs/zh/organize/settings-seo.md): 在 docs.json 中配置 SEO 设置，包括站点描述、搜索引擎索引、meta 标签、搜索栏占位符和页面时间戳。 - [docs.json schema 参考](https://www.mintlify.com/docs/zh/organize/settings-reference.md): 所有 `docs.json` 配置属性的完整参考，包含类型、默认值和描述。 ## 管理站点 - [导航](https://www.mintlify.com/docs/zh/organize/navigation.md): 在 docs.json 中使用分组、页面、下拉菜单、标签页和锚点配置文档站点导航，构建侧边栏结构。 - [上下文菜单](https://www.mintlify.com/docs/zh/ai/contextual-menu.md): 为你的文档添加上下文菜单，一键集成 ChatGPT、Claude、Perplexity、Google AI Studio、Devin、Devin Desktop 和 MCP 工具。 - [重定向](https://www.mintlify.com/docs/zh/create/redirects.md): 在 docs.json 中配置 URL 重定向规则，为已移动、重命名或删除的文档页面保留 SEO 排名，并防止读者遇到失效链接。 - [从发布中排除文件](https://www.mintlify.com/docs/zh/organize/mintignore.md): 使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外，语法类似 .gitignore。 ## 存储库设置 - [Monorepo 设置](https://www.mintlify.com/docs/zh/deploy/monorepo.md): 在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。 - [多仓库部署](https://www.mintlify.com/docs/zh/deploy/multi-repo.md): 将多个 Git 仓库中的文件合并到一个 Mintlify 站点，并为每个源仓库分配独立的 URL 路径。 ## 视觉自定义 - [主题](https://www.mintlify.com/docs/zh/customize/themes.md): 选择一个主题，自定义文档的外观样式。 - [字体](https://www.mintlify.com/docs/zh/customize/fonts.md): 使用 Google Fonts 或自托管字体文件，为标题、正文和代码块自定义文档站点的排版样式。 - [自定义脚本](https://www.mintlify.com/docs/zh/customize/custom-scripts.md): 为你的文档站点添加自定义 JavaScript 和 CSS，用于分析、小组件、样式覆盖、第三方集成和 API Playground 服务器变量。支持身份验证、租户切换和注销后的运行时更新，值仅保存在当前会话内存中，不会写入浏览器存储。 - [自定义 404 页面](https://www.mintlify.com/docs/zh/customize/custom-404-page.md): 自定义文档站点 404 错误页面的标题、描述和外观，以匹配你的品牌风格并引导访客。 ## 分析 - [分析概览](https://www.mintlify.com/docs/zh/analytics/index.md): 使用 Mintlify 分析 dashboard 了解文档的流量、助手使用情况、搜索、参与度和反馈。 - [分析文档流量](https://www.mintlify.com/docs/zh/analytics/traffic.md): 使用流量分析跟踪访客、页面浏览量、引荐来源,以及来自人类和 AI agent 的流量。 - [分析助手对话](https://www.mintlify.com/docs/zh/analytics/assistant.md): 使用助手分析了解对话主题、满意度、使用趋势和文档缺口。 - [分析文档搜索](https://www.mintlify.com/docs/zh/analytics/search.md): 使用搜索分析了解查询趋势、无结果的搜索以及结果点击率。 - [分析用户参与](https://www.mintlify.com/docs/zh/analytics/user-engagements.md): 使用参与度分析解读内容操作、CTA 表现、用户流,以及搜索和助手漏斗。 - [收集来自用户和 AI 智能体的页面反馈](https://www.mintlify.com/docs/zh/optimize/feedback.md): 启用反馈小部件、页面评分、上下文备注、代码片段反应以及智能体反馈，帮助你发现并修复文档中的问题。 - [将分析导出为 CSV](https://www.mintlify.com/docs/zh/analytics/export.md): 将分析类别导出为 CSV,并解读流量和助手导出字段。 - [将分析事件流式传输到 Amazon S3](https://www.mintlify.com/docs/zh/analytics/streaming.md): 配置 Enterprise 分析流式传输,将选定的事件类别和部署发送到 Amazon S3。 ## 部署 - [部署](https://www.mintlify.com/docs/zh/deploy/deployments.md): 在 Mintlify 控制台中管理文档部署，包括查看部署历史、监控构建状态和故障排查。 - [预览部署](https://www.mintlify.com/docs/zh/deploy/preview-deployments.md): 为每个拉取请求获取唯一的预览 URL，让审阅者可以在实时环境中查看文档更改，然后再合并到生产环境。 - [GitHub](https://www.mintlify.com/docs/zh/deploy/github.md): 将你的 GitHub 仓库连接到 Mintlify，实现自动部署、拉取请求预览构建和持续文档同步。 - [GitHub Enterprise Server](https://www.mintlify.com/docs/zh/deploy/ghes.md): 在你的 GitHub Enterprise Server 实例上安装和配置 Mintlify GitHub 应用，实现文档自动部署和同步。 - [GitLab](https://www.mintlify.com/docs/zh/deploy/gitlab.md): 将 GitLab 仓库连接到 Mintlify，实现自动化文档部署、合并请求预览和持续同步。 - [Bitbucket Cloud](https://www.mintlify.com/docs/zh/deploy/bitbucket.md): 将 Bitbucket Cloud 仓库连接到 Mintlify，实现自动化部署、拉取请求预览和持续同步。 ## 托管 - [自定义域名](https://www.mintlify.com/docs/zh/customize/custom-domain.md): 使用 DNS 记录、自动 TLS 证书以及 Mintlify 托管或代理流量路由，将你的站点托管在自己的域名、子域名或子路径下。 ## 子路径托管 - [在子路径下托管文档](https://www.mintlify.com/docs/zh/deploy/docs-subpath.md): 使用 Cloudflare Workers、Vercel 重写规则或 nginx 反向代理，将你的 Mintlify 文档托管在主域名的类似 /docs 的子路径下。 - [使用 Cloudflare Workers 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/cloudflare.md): 通过 Cloudflare Workers 将你的 Mintlify 文档部署到域名的子路径，包含分步设置和 DNS 配置说明。 - [使用 AWS Route 53 和 CloudFront 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/route53-cloudfront.md): 通过组合 Route 53 DNS 路由、CloudFront 分发和缓存行为，将你的 Mintlify 文档部署到 AWS 子路径。 - [使用 Vercel 在子路径下部署](https://www.mintlify.com/docs/zh/deploy/vercel.md): 通过 Vercel 重写规则将你的 Mintlify 站点托管在主域名的子路径下，并附有分步的 vercel.json 配置演练。 - [在 Vercel 前使用外部代理](https://www.mintlify.com/docs/zh/deploy/vercel-external-proxies.md): 在你的 Vercel 部署前配置 Cloudflare 或 Nginx 等外部反向代理，以在自定义子路径下提供 Mintlify 文档。 - [反向代理](https://www.mintlify.com/docs/zh/deploy/reverse-proxy.md): 使用 nginx 或类似工具配置自定义反向代理，在你自己的域名子路径上提供 Mintlify 文档服务。 ## 托管 - [内容安全策略（CSP）配置](https://www.mintlify.com/docs/zh/deploy/csp-configuration.md): 配置内容安全策略标头，在允许 Mintlify 资源的同时，为反向代理和严格网络策略维护安全性。 - [自托管](https://www.mintlify.com/docs/zh/deploy/self-host.md): 在你自己的云或本地环境中运行 Mintlify，可部署在 AWS 或任何 Kubernetes 平台上，包括 Azure、Google Cloud、Oracle Cloud 和 OpenShift。 - [定制开发者门户](https://www.mintlify.com/docs/zh/deploy/custom-portal.md): 在自托管 Mintlify 之上部署完全定制的开发者门户，由 Mintlify 设计和构建，并通过版本化发布交付。 ## 导出站点 - [离线导出](https://www.mintlify.com/docs/zh/deploy/export.md): 将文档站点导出为自包含的 zip 压缩包，用于离线查看、内部分发或隔离环境托管。 - [导出 PDF](https://www.mintlify.com/docs/zh/optimize/pdf-exports.md): 将整个文档站点导出为带有可导航目录的单个 PDF 文件，便于离线阅读、分享和打印。 ## 身份验证 - [认证设置](https://www.mintlify.com/docs/zh/deploy/authentication-setup.md): 了解如何为 Mintlify 文档站点配置用户认证，使用密码、OAuth、JWT、Info API 或 OAuth 令牌声明控制页面和 API 参考的访问权限，并管理用户登录、公开页面、受保护页面、会话时长以及基于用户组的内容访问。查看不同认证方式的前提条件、配置步骤、用户数据格式和功能可用性。 - [单点登录（SSO）](https://www.mintlify.com/docs/zh/dashboard/sso.md): 使用 Okta、Azure AD 和 Google Workspace 等 SAML 或 OIDC 身份提供商设置单点登录，实现安全的团队身份验证。 - [SCIM 预配](https://www.mintlify.com/docs/zh/dashboard/scim.md): 使用 SCIM 从你的身份提供商为控制台成员进行预配和取消预配。 - [会话安全](https://www.mintlify.com/docs/zh/dashboard/session-security.md): 配置仪表盘会话超时、最长会话生命周期以及 IP 允许列表，以实施更严格的身份验证和网络访问策略。 ## 安全 - [Dashboard 访问策略](https://www.mintlify.com/docs/zh/dashboard/network-access.md): 将 Mintlify dashboard 的访问限制为受信任的 IP 地址，并通过空闲超时和最大会话有效期控制 dashboard 会话的有效时长。 - [角色](https://www.mintlify.com/docs/zh/dashboard/roles.md): 为团队成员分配管理员、编辑者或查看者角色，控制 Mintlify 中的访问级别、编辑权限和部署能力。 - [审计日志](https://www.mintlify.com/docs/zh/dashboard/audit-logs.md): 查看审计日志，追踪组织成员执行的操作，包括部署、配置更改和权限更新。 - [安全联系人](https://www.mintlify.com/docs/zh/dashboard/security-contact.md): 为你的组织配置安全联系人邮箱地址，用于接收漏洞报告、安全警报和合规更新。 ## Agent - [什么是 agent？](https://www.mintlify.com/docs/zh/agent/index.md): 使用 Mintlify agent 自动化文档更新。可通过 Slack 消息、pull request 或 API 调用触发变更。 - [将 agent 添加到 Slack](https://www.mintlify.com/docs/zh/agent/slack.md): 在 Slack 中安装 Mintlify agent，用于询问产品相关问题、根据团队对话创建内容更新，并将知识沉淀到 pull request 中。 ## 自动化 - [自动化概览](https://www.mintlify.com/docs/zh/automations/index.md): 使用 Mintlify 自动化，自动维护内容：按计划、在仓库推送时或在已连接集成的事件上运行 agent。 - [创建自定义自动化](https://www.mintlify.com/docs/zh/automations/create.md): 创建 Mintlify 自动化，按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。 - [管理自动化](https://www.mintlify.com/docs/zh/automations/manage.md): 从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。 - [用于 agent 和自动化的集成](https://www.mintlify.com/docs/zh/automations/integrations.md): 连接第三方应用，让 Mintlify agent 在 Slack 对话和自动化运行中使用实时上下文，或通过集成事件触发自动化。了解共享和个人集成的连接范围、支持的应用、只读访问权限，以及如何从控制台或 Slack 连接集成，并在自动化中配置工具、触发器和授权流程。 - [预定义自动化](https://www.mintlify.com/docs/zh/automations/reference.md): 所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。 - [自托管 GitLab OAuth](https://www.mintlify.com/docs/zh/deploy/gitlab-self-hosted.md): 通过 OAuth 将自托管的 GitLab 实例连接到 Mintlify，让自动化能够代表你克隆存储库、推送提交和发起合并请求。 ## Agent - [自定义 Agent 行为](https://www.mintlify.com/docs/zh/agent/customize.md): 使用 `AGENTS.md` 配置文件自定义 agent 行为，控制其处理文档任务和遵循约定的方式。 - [编写高效提示词](https://www.mintlify.com/docs/zh/agent/effective-prompts.md): 编写清晰、具体的提示词以从 Mintlify agent 获得更好的结果，包含有效指令示例和常见模式的实用技巧。 - [Mintlify agent 使用场景和示例](https://www.mintlify.com/docs/zh/agent/use-cases.md): 了解如何使用 Mintlify agent 在 Slack、拉取请求和 API 工作流中自动更新文档、生成代码示例、处理反馈、沉淀团队知识，并在产品发布后持续维护内容准确性。覆盖从 Slack 线程迭代提示词，到合并功能变更、生成发布说明和通过 API 创建任务的常见场景，帮助团队选择适合的文档维护方式。 ## Assistant - [AI 助手](https://www.mintlify.com/docs/zh/assistant/index.md): 为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。 - [配置 AI 助手](https://www.mintlify.com/docs/zh/assistant/configure.md): 在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。 - [自定义 AI 助手行为](https://www.mintlify.com/docs/zh/assistant/customize.md): 通过在文档中添加包含系统指令的 Assistant.md 文件来自定义 AI 助手，塑造其语气、角色定位、关注领域、回答格式与整体响应行为。 - [嵌入 AI 助手小组件](https://www.mintlify.com/docs/zh/assistant/widget.md): 安装并配置 Mintlify 小组件,在任意网站或 Web 应用中嵌入基于你的内容训练的 AI 助手。 - [添加 assistant skills](https://www.mintlify.com/docs/zh/assistant/skills.md): 编写专家级 Markdown 指南（skills），AI 助手在需要时按需加载，使用你的团队手写、有明确观点的内容来回答用户问题并遵循内部规范。 - [使用 AI 助手](https://www.mintlify.com/docs/zh/assistant/use.md): 通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。 ## 面向 Agent 的内容 - [管理员 Model Context Protocol (MCP) 服务器](https://www.mintlify.com/docs/zh/ai/mintlify-mcp.md): 让 Claude、ChatGPT 和 Cursor 等 AI 工具获得对你的 Mintlify 内容和控制台的写入权限，从而编辑页面、更新设置并提交 PR。 ## Mintlify Index - [Mintlify Index](https://www.mintlify.com/docs/zh/search-index/index.md): 通过一个 MCP 服务器或 REST API，为编码代理提供来自发布者维护的文档和 Web 的最新技术上下文。 - [将 Mintlify Index 连接到你的编码代理](https://www.mintlify.com/docs/zh/search-index/connect.md): 通过 CLI 或手动配置，在 Claude Code、Cursor、VS Code、Codex、OpenCode、Windsurf 或 Zed 中设置 Mintlify Index MCP 服务器。 - [Mintlify Index MCP 服务器](https://www.mintlify.com/docs/zh/search-index/mcp.md): 公开 Mintlify Index MCP 服务器的参考文档：连接 URL、context 工具、参数、响应格式、速率限制和使用示例。 ## 面向 Agent 的内容 - [Model Context Protocol (MCP)（模型上下文协议）](https://www.mintlify.com/docs/zh/ai/model-context-protocol.md): 将 Claude、Cursor、ChatGPT 等 AI 工具连接到托管的搜索 MCP 服务器，让它们能够搜索并检索你站点上的文档内容和 API 端点。 - [llms.txt](https://www.mintlify.com/docs/zh/ai/llmstxt.md): 自动生成 llms.txt 和 llms-full.txt 文件，使 ChatGPT 和 Claude 等 AI 工具能够索引并理解你的文档。 - [skill.md](https://www.mintlify.com/docs/zh/ai/skillmd.md): 通过自动生成的 skill.md 能力文件，让你的文档随时可供 AI 智能体使用，并向其描述产品可用的能力。 - [Markdown 导出](https://www.mintlify.com/docs/zh/ai/markdown-export.md): 将文档页面导出为整洁的 Markdown 格式，用于 AI 工具、LLM 集成和自动化内容处理工作流程。 ## 搜索与 SEO - [配置站内搜索的排名、结果和筛选器](https://www.mintlify.com/docs/zh/optimize/search.md): 配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。 - [SEO（搜索引擎优化）](https://www.mintlify.com/docs/zh/optimize/seo.md): 配置元标签、Open Graph 属性、规范 URL 和页面级 SEO 设置，提升文档在搜索引擎中的排名。 ## 编写 API 文档 - [操作台](https://www.mintlify.com/docs/zh/api-playground/overview.md): 让开发者在文档中直接测试 API 端点，交互式演练场可发送真实请求并显示响应结果。 ## API 规范 - [OpenAPI 设置](https://www.mintlify.com/docs/zh/api-playground/openapi-setup.md): 从 OpenAPI 3.0 和 3.1 规范文件生成交互式 API 文档，自动创建端点页面、请求构建器和导航结构，并配置身份验证、服务器 URL、请求参数与文件上传，帮助你快速发布完整且易于测试的 API 参考文档。了解如何设置规范文件、服务器地址、安全方案和文件字段。 - [AsyncAPI 配置](https://www.mintlify.com/docs/zh/api-playground/asyncapi-setup.md): 使用 AsyncAPI 规范文件设置实时 WebSocket 文档，生成交互式频道和消息参考页面。 - [GraphQL 设置](https://www.mintlify.com/docs/zh/api-playground/graphql-setup.md): 从 schema 定义文件为你的 GraphQL API 生成参考页面，包含相互链接的类型以及示例 query、mutation 和响应。 ## SDK 参考设置 - [SDK 参考设置](https://www.mintlify.com/docs/zh/api-playground/sdk-reference-setup.md): 了解如何使用 TypeDoc、DocFX、Javadoc、Sphinx 或 phpDocumentor 的构建产物，在 Mintlify 中自动生成 SDK 参考页面、导航分组、跨页链接和搜索索引，并通过 CI 或远程源保持内容更新。本文还介绍格式配置、目录路径、远程压缩包和仓库组织方式。 - [添加 SDK 示例](https://www.mintlify.com/docs/zh/api-playground/adding-sdk-examples.md): 为你的 API 文档添加 SDK 代码示例，使用 Speakeasy 和 Stainless 自动生成的多语言示例。 ## 端点页面 - [复杂数据类型](https://www.mintlify.com/docs/zh/api-playground/complex-data-types.md): 使用 oneOf、anyOf 和 allOf 关键字描述具有灵活 schema 的 API，支持可选属性、多态性和多种数据格式。 - [多种响应](https://www.mintlify.com/docs/zh/api-playground/multiple-responses.md): 为 API 端点记录多种响应变体，包括成功和错误情况，并附带状态码和示例 payload。 - [管理页面可见性](https://www.mintlify.com/docs/zh/api-playground/managing-page-visibility.md): 通过隐藏、过滤或整理自动生成的 OpenAPI 页面，控制哪些 API 端点出现在文档导航中。 - [手动创建 API 文档页面](https://www.mintlify.com/docs/zh/api-playground/mdx-setup.md): 当你需要完全控制布局时，使用 MDX 文件手动创建 API 参考页面，适用于小型 API、原型开发或自定义文档。 ## 编写 API 文档 - [故障排查](https://www.mintlify.com/docs/zh/api-playground/troubleshooting.md): 排查 API 演练场配置中的常见问题，包括 OpenAPI 验证错误、缺失的端点和身份验证问题。 ## Analytics - [Analytics 集成](https://www.mintlify.com/docs/zh/integrations/analytics/overview.md): 将 Mintlify 文档连接到 Google Analytics、Mixpanel、PostHog 等分析平台，追踪访客参与情况。 - [Adobe Analytics](https://www.mintlify.com/docs/zh/integrations/analytics/adobe.md): 使用 Adobe Experience Platform Launch 标签将 Adobe Analytics 集成到你的 Mintlify 文档站点，实现详细的使用情况跟踪。 - [Amplitude](https://www.mintlify.com/docs/zh/integrations/analytics/amplitude.md): 将 Amplitude Analytics 集成到你的 Mintlify 文档站点，以跟踪用户行为、页面浏览量和内容参与指标。 - [Clarity](https://www.mintlify.com/docs/zh/integrations/analytics/clarity.md): 将 Microsoft Clarity 集成到你的 Mintlify 文档站点，以捕获会话录制、热图和用户交互分析。 - [Clearbit](https://www.mintlify.com/docs/zh/integrations/analytics/clearbit.md): 将 Clearbit 与你的 Mintlify 文档集成，丰富访客数据、识别访问企业并追踪企业级互动。 - [Fathom](https://www.mintlify.com/docs/zh/integrations/analytics/fathom.md): 将 Fathom Analytics 集成到你的 Mintlify 文档，通过简单的站点 ID 配置实现符合 GDPR、注重隐私的访客跟踪。 - [Google Analytics 4](https://www.mintlify.com/docs/zh/integrations/analytics/google-analytics.md): 将 Google Analytics 4 集成到你的 Mintlify 文档，通过 GA4 ID 跟踪访客行为、页面浏览量和内容参与情况。 - [Google Tag Manager](https://www.mintlify.com/docs/zh/integrations/analytics/google-tag-manager.md): 将 Google Tag Manager 集成到你的 Mintlify 文档，集中管理分析标签、转化跟踪和营销事件。 - [Heap](https://www.mintlify.com/docs/zh/integrations/analytics/heap.md): 将 Heap 分析集成到 Mintlify 文档站点，自动捕获用户交互和事件，进行行为分析。 - [Hightouch](https://www.mintlify.com/docs/zh/integrations/analytics/hightouch.md): 将 Hightouch 集成到你的 Mintlify 文档，同步分析数据以实现受众激活、分群和下游工具路由。 - [Hotjar](https://www.mintlify.com/docs/zh/integrations/analytics/hotjar.md): 将 Hotjar 集成到你的 Mintlify 文档站点，捕获会话录制、热图和用户反馈，获取体验洞察。 - [LogRocket](https://www.mintlify.com/docs/zh/integrations/analytics/logrocket.md): 将 LogRocket 集成到你的 Mintlify 文档，回放用户会话、监控前端错误，并详细调试交互问题。 - [Mixpanel](https://www.mintlify.com/docs/zh/integrations/analytics/mixpanel.md): 将 Mixpanel 集成到你的 Mintlify 文档站点，以跟踪产品分析、用户行为漏斗和内容参与事件。 - [Pirsch](https://www.mintlify.com/docs/zh/integrations/analytics/pirsch.md): 将 Pirsch 集成到你的 Mintlify 文档，实现符合 GDPR 的无 Cookie 分析跟踪，不收集个人数据。 - [Plausible](https://www.mintlify.com/docs/zh/integrations/analytics/plausible.md): 将 Plausible Analytics 集成到你的 Mintlify 文档，实现轻量级、尊重隐私的访客跟踪，无需 Cookie 或同意横幅。 - [PostHog](https://www.mintlify.com/docs/zh/integrations/analytics/posthog.md): 将 PostHog 集成到你的 Mintlify 文档站点，使用 API 密钥跟踪产品分析、功能使用情况和用户行为。 - [Segment](https://www.mintlify.com/docs/zh/integrations/analytics/segment.md): 将 Segment 集成到你的 Mintlify 文档，将分析事件路由到数据仓库、CRM 和营销平台等下游工具。 ## SDK - [Speakeasy](https://www.mintlify.com/docs/zh/integrations/sdks/speakeasy.md): 在你的 API 操作台中展示由 Speakeasy 自动生成的 SDK 代码示例，支持 Python、TypeScript、Go 等多种语言。 - [Stainless](https://www.mintlify.com/docs/zh/integrations/sdks/stainless.md): 在你的 API 操作台中展示由 Stainless 自动生成的类型安全 SDK 代码示例，支持 Python、TypeScript 等多种语言。 ## 支持 - [支持平台集成](https://www.mintlify.com/docs/zh/integrations/support/overview.md): 将你的 Mintlify 文档连接到 Intercom 和 Front 等支持平台，让访客可以直接从文档页面获得实时帮助。 - [Intercom](https://www.mintlify.com/docs/zh/integrations/support/intercom.md): 将 Intercom 聊天小部件集成到你的 Mintlify 文档站点，提供实时客户消息、支持和引导帮助。 - [Front](https://www.mintlify.com/docs/zh/integrations/support/front.md): 将 Front 聊天集成到你的 Mintlify 文档站点，让访客可以直接从文档页面发起客户支持会话。 ## 隐私 - [隐私集成](https://www.mintlify.com/docs/zh/integrations/privacy/overview.md): 将你的 Mintlify 文档站点连接到 Osano、Transcend 等隐私平台，管理 Cookie 同意、合规横幅和用户偏好设置。 - [Osano](https://www.mintlify.com/docs/zh/integrations/privacy/osano.md): 将 Osano 集成到你的 Mintlify 文档站点，管理 Cookie 同意横幅、隐私偏好设置和监管合规要求。 - [Transcend](https://www.mintlify.com/docs/zh/integrations/privacy/transcend.md): 将 Transcend 同意管理与你的 Mintlify 文档集成，使用你现有的 Transcend bundle 在获得访客同意后再加载分析。 ## 参考 - [核心概念](https://www.mintlify.com/docs/zh/reference/concepts.md): 了解 Mintlify 如何连接你的组织、文档存储库、编辑工作流、部署以及 AI 功能。 - [术语表](https://www.mintlify.com/docs/zh/reference/glossary.md): 查找 Mintlify 产品、内容、导航、部署、Git、API 和 AI 相关术语的定义。 - [积分定价](https://www.mintlify.com/docs/zh/credits.md): 了解组织的积分余额如何运作、哪些功能会消耗积分，以及我们如何对积分套餐、超额使用和结转进行计费。 ## API 参考 - [简介](https://www.mintlify.com/docs/zh/api/introduction.md): 使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。 ## 管理 - [触发部署](https://www.mintlify.com/docs/zh/api/update/trigger.md): 为你的文档项目排队一次部署更新。返回一个状态 ID，用于跟踪更新进度。更新将从你配置的部署用分支触发。 - [获取部署状态](https://www.mintlify.com/docs/zh/api/update/status.md): 通过状态 ID 获取更新状态 - [触发预览部署](https://www.mintlify.com/docs/zh/api/preview/trigger.md): 为特定分支创建或更新预览部署。如果该分支已有预览，则会触发重新部署。返回用于跟踪进度的状态 ID 和预览 URL。 - [触发自动化](https://www.mintlify.com/docs/zh/api/automations/trigger.md): 立即触发计划自动化运行，而无需等待其下一次预定时间。适合从 CI/CD 流水线中运行自动化，例如在每次合并到默认分支时运行的 GitHub Action。仅支持触发计划（自定义计划）自动化。该次运行会处理自上次完成运行以来的变更，与常规计划运行完全相同。 ## Agent - [创建 Agent 作业](https://www.mintlify.com/docs/zh/api/agent/v2/create-agent-job.md): 创建一个在后台运行的新代理作业。该作业会异步处理提示词——轮询 get job 端点以跟踪进度。如果代理成功编辑文件，则会自动创建拉取请求（PR；亦称“合并请求”/Merge Request）。 - [获取代理任务](https://www.mintlify.com/docs/zh/api/agent/v2/get-agent-job.md): 检索代理作业的当前状态和详细信息。轮询此端点以跟踪作业进度。 - [发送后续消息](https://www.mintlify.com/docs/zh/api/agent/v2/send-message.md): 向现有代理任务发送后续消息。该消息将异步处理——请轮询 get job 端点以跟踪进度。 ## Assistant - [创建 assistant 消息](https://www.mintlify.com/docs/zh/api/assistant/create-assistant-message-v2.md): 针对指定的 domain，从 AI 助手生成一条回复消息。适用于 AI SDK v5 及更高版本。 ## 搜索 - [搜索文档](https://www.mintlify.com/docs/zh/api/assistant/search.md): 在你的文档中执行语义搜索和关键词搜索，并支持可配置的过滤和分页。 - [获取页面内容](https://www.mintlify.com/docs/zh/api/assistant/get-page-content.md): 通过路径检索特定文档页面的完整文本内容。在搜索之后使用此接口来获取匹配页面的完整内容。 ## Mintlify Index - [Mintlify Index REST API](https://www.mintlify.com/docs/zh/api/search-index/introduction.md): 使用 Mintlify Index REST API 搜索文档和 Web，组装带有来源引用的上下文，并为应用和代理获取页面内容。 - [构建实现上下文](https://www.mintlify.com/docs/zh/api/search-index/context.md): 搜索 Mintlify Index，并在 token 预算内组装带有来源引用的内容。当应用或代理需要通过一次请求获取可直接使用的上下文时，请使用此端点。 - [搜索技术知识](https://www.mintlify.com/docs/zh/api/search-index/search.md): 返回发布者维护的文档或 Web 中的排名结果。需要更多内容时，请将 Mintlify 结果 ID 或任意结果 URL 与 contents 端点搭配使用。 - [获取结果内容](https://www.mintlify.com/docs/zh/api/search-index/contents.md): 获取搜索端点返回的 Mintlify 结果 ID 或结果 URL 对应的内容。一次请求最多可以在两个字段中包含 20 项。 ## 数据分析 - [获取反馈](https://www.mintlify.com/docs/zh/api/analytics/feedback.md): 返回按页划分的用户反馈，并支持可选筛选条件 - [按页面获取反馈](https://www.mintlify.com/docs/zh/api/analytics/feedback-by-page.md): 按页面获取 Mintlify 文档的用户反馈汇总数据，包括每个页面的赞、踩、代码片段复制次数以及反馈总数。 - [获取 AI 助手会话记录](https://www.mintlify.com/docs/zh/api/analytics/assistant-conversations.md): 返回分页后的 AI 助手会话历史 - [获取 AI 助手会话线程](https://www.mintlify.com/docs/zh/api/analytics/assistant-thread.md): 返回单个 AI 助手会话线程的完整消息转录。线程 ID 可从 AI 助手会话端点获取，或作为 AI 助手链接转接支持 URL 上追加的 `threadId` 查询参数获取。 - [获取 AI 助手调用方统计](https://www.mintlify.com/docs/zh/api/analytics/assistant-caller-stats.md): 返回指定日期范围内按调用方类型（网页端、API 和其他）划分的助手查询次数明细。 - [获取搜索查询](https://www.mintlify.com/docs/zh/api/analytics/searches.md): 导出 Mintlify 文档的搜索查询记录，包含每个搜索词的命中数、点击率以及最近一次被搜索的时间，便于分析用户搜索行为。 - [获取页面浏览量](https://www.mintlify.com/docs/zh/api/analytics/views.md): 获取 Mintlify 文档的页面浏览量统计，按路径细分，并区分来自真实用户与 AI 爬虫或代理的流量来源。 - [获取唯一访客](https://www.mintlify.com/docs/zh/api/analytics/visitors.md): 获取 Mintlify 文档的唯一访客数量，按路径与站点整体统计，并区分真实用户流量与 AI 爬虫或代理产生的访问。 ## 静态导出 - [启动静态导出作业](https://www.mintlify.com/docs/zh/api/static-export/start-job.md): 为部署启动一个静态导出任务。该任务会将你的文档预渲染为一组自包含的静态 HTML、RSC 及资源文件。返回一个任务 ID，可用于轮询状态；任务完成后，还可用它生成可下载的软件包。 - [获取静态导出作业状态](https://www.mintlify.com/docs/zh/api/static-export/get-job-status.md): 获取静态导出任务的当前状态和进度。启动任务后，可以轮询此端点，直到 `status` 变为 `completed`（或 `failed`）。 - [生成导出包](https://www.mintlify.com/docs/zh/api/static-export/generate-bundle.md): 将已完成的静态导出任务打包为单个归档文件，并返回一个下载链接。该链接为预签名的 S3 URL —— 请在 `expiresAt` 之前下载。 ## 帮助中心 - [修复 "Failed to fetch OpenAPI file for anchor or tab" 错误](https://www.mintlify.com/docs/zh/help-center/openapi-url-fetch-fails-during-build.md): 解决 Mintlify 构建因私有主机、需要认证的 URL、TLS、DNS 或 CI 竞争条件而无法下载托管的 OpenAPI 文档的问题。 - [修复 "Domain already claimed by another organization" 错误](https://www.mintlify.com/docs/zh/help-center/domain-already-claimed-by-another-organization.md): 从其他 Mintlify 部署释放自定义域名，或在因其他部署或组织占用而无法添加域名时申请支持。 - [使用 Auth0 配置 OAuth 2.0 身份验证](https://www.mintlify.com/docs/zh/help-center/configure-oauth-with-auth0.md): 为私有 Mintlify 文档站点将 Auth0 设置为 OAuth 2.0 身份提供方，包括端点 URL、回调注册和基于用户组的访问控制。 - [创建第二个部署时私有仓库未出现](https://www.mintlify.com/docs/zh/help-center/private-repo-missing-when-creating-second-deployment.md): 重新授权 Mintlify 以获得私有仓库访问权限，使现有的私有 GitHub 仓库出现在新部署的引导仓库选择器中。 - [修复文档站点上返回 404 的静态文件](https://www.mintlify.com/docs/zh/help-center/static-file-not-served.md): 诊断你添加到文档仓库中的文件（例如 JSON、PDF 或图片）为什么无法在 Mintlify 站点上通过预期 URL 加载。 ## 概览 - [指南](https://www.mintlify.com/docs/zh/guides/index.md): 浏览文档最佳实践、内容策略、SEO 优化、可访问性和 docs-as-code 工作流程的实用指南。 ## AI - [构建应用内助手](https://www.mintlify.com/docs/zh/guides/assistant-embed.md): 构建并嵌入一个应用内文档助手，使用来自你的 Mintlify 文档站点的引用信息回答用户问题。 - [配置 GitHub 应用的自动合并](https://www.mintlify.com/docs/zh/guides/configure-automerge.md): 通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流以自动合并 Mintlify pull request。 - [使用自动化](https://www.mintlify.com/docs/zh/guides/use-automations.md): 使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。 - [使用 Claude Code 编写文档](https://www.mintlify.com/docs/zh/guides/claude-code.md): 通过 CLAUDE.md 项目说明配置 Claude Code，按照你的风格指南撰写、审阅和更新你的 Mintlify 文档。 - [使用 Codex 编写文档](https://www.mintlify.com/docs/zh/guides/codex.md): 通过项目说明和 MCP 配置 OpenAI Codex CLI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。 - [使用 Cursor 编写文档](https://www.mintlify.com/docs/zh/guides/cursor.md): 使用项目规则配置 Cursor，以编写遵循你的样式指南、组件使用规范和 MDX 约定的 Mintlify 文档。 - [使用 Devin Desktop 编写文档](https://www.mintlify.com/docs/zh/guides/devin-desktop.md): 使用工作区规则配置 Devin Desktop 的 Cascade AI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。 - [GEO 指南：为 AI 搜索和答案引擎优化文档](https://www.mintlify.com/docs/zh/guides/geo.md): 使用 Generative Engine Optimization 技术，为 ChatGPT、Perplexity 和 Google AI Overviews 等 AI 驱动的答案引擎优化你的文档。 ## API 文档 - [将 MDX API 页面迁移到 OpenAPI 导航](https://www.mintlify.com/docs/zh/guides/migrating-from-mdx.md): 迁移到通过 OpenAPI 自动生成、并具有灵活导航结构的文档。 ## 最佳实践 - [如何创建无障碍文档](https://www.mintlify.com/docs/zh/guides/accessibility.md): 遵循 WCAG 指南创建无障碍文档，包括语义化 HTML、键盘导航、替代文本和包容性内容实践。 - [更新日志](https://www.mintlify.com/docs/zh/create/changelogs.md): 创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志，让用户及时了解最新动态。 - [文档内容类型](https://www.mintlify.com/docs/zh/guides/content-types.md): 使用 Diátaxis 框架为每个页面选择合适的文档类型：教程、操作指南、参考和解释。 - [文档内容模板](https://www.mintlify.com/docs/zh/guides/content-templates.md): 复制并修改即用型 MDX 模板，用于在文档中撰写操作指南、教程、概念解释和 API 参考页面。 - [构建自定义页面布局](https://www.mintlify.com/docs/zh/guides/custom-layouts.md): 使用页面模式和组件在 Mintlify 文档中构建自定义落地页、营销页面及其他非标准布局。 - [如何衡量和提升文档质量](https://www.mintlify.com/docs/zh/guides/improving-docs.md): 使用分析数据、用户反馈和内容审计来识别文档中的不足，并改善对用户最重要的页面。 - [如何设置多语言文档](https://www.mintlify.com/docs/zh/guides/internationalization.md): 设置多语言文档，支持基于语言区域的路由、语言切换导航和翻译内容，以覆盖全球用户。 - [如何有效地链接文档页面](https://www.mintlify.com/docs/zh/guides/linking.md): 在文档中创建内部链接、锚点链接和深层链接，并通过重定向和断链检查维护链接完整性。 - [如何长期维护文档](https://www.mintlify.com/docs/zh/guides/maintenance.md): 通过审查计划、责任模型、自动化检查和内容生命周期实践，保持文档的准确性和时效性。 - [如何在文档中使用图片、截图和视频](https://www.mintlify.com/docs/zh/guides/media.md): 了解何时以及如何在文档中使用截图、GIF 和视频，包括格式选择、替代文本和长期维护方面的指导。 - [如何构建文档导航结构](https://www.mintlify.com/docs/zh/guides/navigation.md): 设计文档导航，通过清晰的信息架构、逻辑分组和经过验证的结构，帮助用户找到所需内容。 - [如何改善文档 SEO](https://www.mintlify.com/docs/zh/guides/seo.md): 通过页面标题、关键词研究、内部链接和技术 SEO 技巧，提升文档在搜索引擎中的排名。 - [如何撰写技术文档](https://www.mintlify.com/docs/zh/guides/style-and-tone.md): 撰写清晰、一致的技术文档，包含关于语气、结构、术语和文风的实用指导，适用于开发者文档和产品文档。 - [如何了解你的文档受众](https://www.mintlify.com/docs/zh/guides/understand-your-audience.md): 定义你的文档受众，研究他们的目标和知识水平，并将这些洞察应用到编写帮助他们成功的内容中。 ## Git - [文档相关的 Git 概念](https://www.mintlify.com/docs/zh/guides/git-concepts.md): 学习用于文档即代码工作流的 Git 版本控制基础知识，包括仓库、branch、commit 和拉取请求协作。 - [使用 branch](https://www.mintlify.com/docs/zh/guides/branches.md): 创建和管理文档 branch，以预览变更、与团队成员协作，并在发布到生产环境之前合并更新。 ## 使用场景 - [创建开发者文档](https://www.mintlify.com/docs/zh/guides/developer-documentation.md): 构建帮助工程师集成你的 API、SDK 和工具的开发者文档，包括快速入门、参考文档和使用指南。 - [创建知识库](https://www.mintlify.com/docs/zh/guides/knowledge-base.md): 在 Mintlify 上托管团队内部知识库，以整合信息、提升搜索效果，并降低维护成本。 - [创建帮助中心](https://www.mintlify.com/docs/zh/guides/help-center.md): 在 Mintlify 上构建自助式帮助中心，帮助客户找到答案，减少支持工单量，并随团队规模扩展。 - [无头文档与自定义前端](https://www.mintlify.com/docs/zh/guides/custom-frontend.md): 使用 Astro 构建无头文档前端，同时借助 Mintlify 进行内容管理、AI 搜索和助手功能。 - [静态导出](https://www.mintlify.com/docs/zh/api/static-export/overview.md): 通过 Mintlify REST API 生成自包含的文档静态导出，并以单个包的形式下载。了解如何预渲染文档、部署静态文件，并在 S3、CDN 或其他静态托管服务上托管。 ## OpenAPI Specs - [admin-openapi](/docs/admin-openapi.json) - [analytics.openapi](/docs/analytics.openapi.json) - [openapi](/docs/api-reference/openapi.json) - [discovery-openapi](/docs/discovery-openapi.json) - [admin-openapi](/docs/es/admin-openapi.json) - [analytics.openapi](/docs/es/analytics.openapi.json) - [discovery-openapi](/docs/es/discovery-openapi.json) - [index-openapi](/docs/es/index-openapi.json) - [openapi](/docs/es/openapi.json) - [static-export-openapi](/docs/es/static-export-openapi.json) - [admin-openapi](/docs/fr/admin-openapi.json) - [analytics.openapi](/docs/fr/analytics.openapi.json) - [discovery-openapi](/docs/fr/discovery-openapi.json) - [index-openapi](/docs/fr/index-openapi.json) - [openapi](/docs/fr/openapi.json) - [static-export-openapi](/docs/fr/static-export-openapi.json) - [index-openapi](/docs/index-openapi.json) - [openapi](/docs/openapi.json) - [static-export-openapi](/docs/static-export-openapi.json) - [admin-openapi](/docs/zh/admin-openapi.json) - [analytics.openapi](/docs/zh/analytics.openapi.json) - [discovery-openapi](/docs/zh/discovery-openapi.json) - [index-openapi](/docs/zh/index-openapi.json) - [openapi](/docs/zh/openapi.json) - [static-export-openapi](/docs/zh/static-export-openapi.json) ## AsyncAPI Specs - [asyncapi](/docs/asyncapi.yaml) - [asyncapi](/docs/es/asyncapi.yaml) - [asyncapi](/docs/fr/asyncapi.yaml) - [asyncapi](/docs/zh/asyncapi.yaml) ## Optional - [Learn](https://learn.mintlify.com/): Self-paced lessons to get the most from Mintlify. - [Apprendre](https://learn.mintlify.com/): Leçons en autonomie pour tirer le meilleur parti de Mintlify. - [Aprender](https://learn.mintlify.com/): Lecciones a tu ritmo para aprovechar al máximo Mintlify. - [学习](https://learn.mintlify.com/): 自定进度的课程，帮助你充分利用 Mintlify。