Skip to main content

Search documentation

Search query

Esc

Type to search this documentation.

Home
Documentation
API reference
Guides
Help center

- Get started
- Create content
  - Pages
    Pages
    Hidden pages
    Related topics
  - Formatting
    Format text
    Format code
    Lists and tables
  - Components
    Accordions
    Badge
    Banner
    Callouts
    Cards
    Code groups
    Color
    Columns
    Examples
    Expandables
    Fields
    Frames
    GitHub
    Icons
    MDX
    Mermaid
    Panel
    Prompt
    Response fields
    Steps
    Tabs
    Tiles
    Tooltips
    Tree
    Update
    View
    Visibility
    React components
  - Media
    Images and embeds
    Files
  - Reusable snippets
  - Personalized content
  - Editor
    How to use the editor
    Edit content
    Publish
    Review
    Collaborate
    Ask agent
    Settings
    Keyboard shortcuts
  - CI checks
- Manage your site
  - Global settings
    Appearance and branding
    Site structure
    API settings
    Integrations
    SEO and search
    docs.json schema reference
  - Navigation
  - Contextual menu
  - Bring your own model
  - Redirects
  - Exclude files
  - Notifications
  - Repository setup
    Monorepo setup
    Multi-repository projects
  - Visual customization
    Themes
    Fonts
    Custom scripts
    Custom 404 page
  - Analytics
    Traffic
    Assistant
    Search
    User engagements
    Feedback
    Export analytics
    Stream events
  - Deployments
    GitHub
    GitHub Enterprise Server
    GitLab
    Bitbucket Cloud
    Preview deployments
    Rollbacks
  - Hosting
    Subpath hosting
    Cloudflare
    AWS
    Vercel
    Reverse proxy
    CSP configuration
    Self-host
    Custom developer portals
  - Export your site
    Offline export
    PDF exports
  - Authentication
    Single sign-on (SSO)
    SCIM user provisioning
    Session security
  - Security
    Access policies
    Roles
    Audit logs
    Security contact
- Agent
- Assistant
- Agent-ready content
  - Admin MCP
  - Mintlify Index
    Connect
    MCP reference
  - Search MCP
  - llms.txt
  - skill.md
  - Markdown export
  - Search
  - SEO
- Document APIs
  - API playground overview
  - API specifications
    OpenAPI setup
    AsyncAPI setup
    GraphQL setup
    SDK reference setup
    Add SDK examples
  - Endpoint pages
    Complex data types
    Multiple responses
    Manage page visibility
    Create manual API pages
  - Troubleshooting
- Integrations
  - Analytics
    Adobe Analytics
    Amplitude
    Clarity
    Clearbit
    Fathom
    Google Analytics 4
    Google Tag Manager
    Heap
    Hightouch
    Hotjar
    LogRocket
    Mixpanel
    Pirsch
    Plausible
    PostHog
    Segment
  - Support
    Intercom
    Front
  - Privacy
    Osano
    Transcend
- Reference

Powered by Doctorine

CLI

View as Markdown Open in ChatGPT Open in ClaudeConnect to Cursor Connect to VS Code

Install the CLI

Mintlify MDX extension

Preview locally

Mintlify CLI command reference

Was this helpful?

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Replacement page (Markdown)Reason (optional)

Export

Documentation menu

- Get started
- Create content
  - Pages
    Pages
    Hidden pages
    Related topics
  - Formatting
    Format text
    Format code
    Lists and tables
  - Components
    Accordions
    Badge
    Banner
    Callouts
    Cards
    Code groups
    Color
    Columns
    Examples
    Expandables
    Fields
    Frames
    GitHub
    Icons
    MDX
    Mermaid
    Panel
    Prompt
    Response fields
    Steps
    Tabs
    Tiles
    Tooltips
    Tree
    Update
    View
    Visibility
    React components
  - Media
    Images and embeds
    Files
  - Reusable snippets
  - Personalized content
  - Editor
    How to use the editor
    Edit content
    Publish
    Review
    Collaborate
    Ask agent
    Settings
    Keyboard shortcuts
  - CI checks
- Manage your site
  - Global settings
    Appearance and branding
    Site structure
    API settings
    Integrations
    SEO and search
    docs.json schema reference
  - Navigation
  - Contextual menu
  - Bring your own model
  - Redirects
  - Exclude files
  - Notifications
  - Repository setup
    Monorepo setup
    Multi-repository projects
  - Visual customization
    Themes
    Fonts
    Custom scripts
    Custom 404 page
  - Analytics
    Traffic
    Assistant
    Search
    User engagements
    Feedback
    Export analytics
    Stream events
  - Deployments
    GitHub
    GitHub Enterprise Server
    GitLab
    Bitbucket Cloud
    Preview deployments
    Rollbacks
  - Hosting
    Subpath hosting
    Cloudflare
    AWS
    Vercel
    Reverse proxy
    CSP configuration
    Self-host
    Custom developer portals
  - Export your site
    Offline export
    PDF exports
  - Authentication
    Single sign-on (SSO)
    SCIM user provisioning
    Session security
  - Security
    Access policies
    Roles
    Audit logs
    Security contact
- Agent
- Assistant
- Agent-ready content
  - Admin MCP
  - Mintlify Index
    Connect
    MCP reference
  - Search MCP
  - llms.txt
  - skill.md
  - Markdown export
  - Search
  - SEO
- Document APIs
  - API playground overview
  - API specifications
    OpenAPI setup
    AsyncAPI setup
    GraphQL setup
    SDK reference setup
    Add SDK examples
  - Endpoint pages
    Complex data types
    Multiple responses
    Manage page visibility
    Create manual API pages
  - Troubleshooting
- Integrations
  - Analytics
    Adobe Analytics
    Amplitude
    Clarity
    Clearbit
    Fathom
    Google Analytics 4
    Google Tag Manager
    Heap
    Hightouch
    Hotjar
    LogRocket
    Mixpanel
    Pirsch
    Plausible
    PostHog
    Segment
  - Support
    Intercom
    Front
  - Privacy
    Osano
    Transcend
- Reference

Powered by Doctorine