Skip to main content
Mintlify

Search documentation

Type to search this documentation.

Guides

Every guide in Mintlify.

Get started

IntroductionQuickstartAI-native

CLI

Install the CLIMintlify MDX extensionPreview locallyCommands

Migration guide

Migrate from DocusaurusMigrate from ReadMeMigrate from GitBookMigrate from FernMigrate from Document360Migrate from another platform

Create content

Pages

PagesHidden pagesRelated topics

Formatting

Format textFormat codeLists and tables

Components

AccordionsBadgeBannerCalloutsCardsCode groupsColorColumnsExamplesExpandablesFieldsFramesGitHubIconsMDXMermaidPanelPromptResponse fieldsStepsTabsTilesTooltipsTreeUpdateViewVisibilityReact components

Media

Images and embedsFiles
Reusable snippetsPersonalized content

Editor

How to use the editorEdit contentPublishReviewCollaborateAsk agentSettingsKeyboard shortcuts
CI checks

Manage your site

Global settings

Appearance and brandingSite structureAPI settingsIntegrationsSEO and searchdocs.json schema reference
NavigationContextual menuBring your own modelRedirectsExclude filesNotifications

Repository setup

Monorepo setupMulti-repository projects

Visual customization

ThemesFontsCustom scriptsCustom 404 page

Analytics

TrafficAssistantSearchUser engagementsFeedbackExport analyticsStream events

Deployments

GitHubGitHub Enterprise ServerGitLabBitbucket CloudPreview deploymentsRollbacks

Hosting

Subpath hosting

CloudflareAWSVercelReverse proxy
CSP configurationSelf-hostCustom developer portals

Export your site

Offline exportPDF exports

Authentication

Single sign-on (SSO)SCIM user provisioningSession security

Security

Access policiesRolesAudit logsSecurity contact

Agent

What is the agent?Add the agent to Slack

Automations

Create a custom automationManage automationsIntegrationsPredefined automationsSelf-hosted GitLab OAuth
Customize agent behaviorWrite effective promptsUse cases

Assistant

AssistantConfigure the assistantCustomize assistant behaviorWidgetAdd assistant skillsNarrationUse the assistant

Agent-ready content

Admin MCP

Mintlify Index

ConnectMCP reference
Search MCPllms.txtskill.mdMarkdown exportSearchSEO

Document APIs

API playground overview

API specifications

OpenAPI setupAsyncAPI setupGraphQL setup

SDK reference setup

Add SDK examples

Endpoint pages

Complex data typesMultiple responsesManage page visibilityCreate manual API pages
Troubleshooting

Integrations

Analytics

Adobe AnalyticsAmplitudeClarityClearbitFathomGoogle Analytics 4Google Tag ManagerHeapHightouchHotjarLogRocketMixpanelPirschPlausiblePostHogSegment

Support

IntercomFront

Privacy

OsanoTranscend

Reference

ConceptsGlossaryCredit pricing

API reference

Mintlify REST API introduction

Admin

Trigger deploymentGet deployment statusTrigger preview deploymentTrigger automationTrigger automation webhook

Agent

Create agent jobGet agent jobSend follow-up message

Assistant

Create assistant messageSearch documentationGet page content

Mintlify Index

OverviewContextSearchContents

Analytics

Get feedbackGet feedback by pageGet assistant conversationsGet assistant conversation threadGet assistant caller statsGet search queriesGet page viewsGet unique visitors

Static export

Start static export jobGet static export job status

Overview

Guides

AI

Build an in-app assistantConfigure automergeUse automationsClaude CodeCodexCursorDevin DesktopGEO

API docs

Migrate from MDX to OAS

Best practices

AccessibilityChangelogsContent typesContent templatesCustom page layoutsImprove your docsInternationalizationLinkingMaintenanceMediaNavigationSEOStyle and toneUnderstand your audience

Git

Git concepts for documentationWork with branches

Use cases

Developer documentationKnowledge baseHelp centerHeadless / Custom frontendStatic export

Help center

Can I rename my project or organization?Change your workspace iconDefault mintlify.app subdomain indexed with custom domainFix "Domain already claimed by another organization" errorPrivate repo missing when creating a second projectPreview deployment not created for a fork branchMintlify static IP for Git provider allowlistsFix agent runs blocked by a git provider IP allow listConfigure OAuth 2.0 authentication with Auth0Fix "Failed to fetch OpenAPI file for anchor or tab" errorFix a static file that returns 404 on your docs siteBranch missing from the web editor branch listTailwind classes not applying in the editor's live previewStyle the icon inside a Card componentFix site search returning no resultsFix llms.txt returning 404 while llms-full.txt worksAdvertise an externally hosted MCP serverWhy your visitor count dropped after crawler filteringMigrate from Confluence to MintlifyMigrate docs into Mintlify from a ZIP exportAgent PRs open against your deploy branchPublish button disabled because of invalid MDX
Documentation menu