Skip to content

Talk to us
Get started

Documentation API reference Changelog Learn

Get started

Introduction Quickstart

Install the CLI Preview locally Commands

Organize

Global settings

Navigation Pages Hidden pages Related topics Exclude files

Customize

Custom domain Themes Fonts Custom scripts React components Custom 404 page

Create content

Format text Format code

Images and embeds Files Lists and tables Reusable snippets Personalized content Redirects Changelogs

Document APIs

API playground overview OpenAPI setup Complex data types Add SDK examples Manage page visibility Multiple responses Create manual API pages AsyncAPI setup GraphQL setup SDK reference setup Troubleshooting

Deploy

Deployments Preview deployments Offline export

Subpath hosting

Authentication setup

Monorepo setup Multi-repository deployments External proxies with Vercel CI checks GitHub GitHub Enterprise Server GitLab Self-hosted GitLab OAuth Self-host Custom developer portals

Optimize

Credit pricing Contextual menu Analytics Feedback llms.txt skill.md Search MCP Search SEO Markdown export PDF exports

CLI

Install the CLI

Install the Mintlify CLI to preview documentation locally, test changes in real time, and catch build errors before deploying to production.

Was this page helpful?Suggest edits Raise issue

PreviousMintlify CLI NextPreview locally

Explore

Startups
Enterprise
Switch

Resources

Learn
Customers
Blog
Pricing
Contact support
Feature requests
Status

Company

Careers
Wall of love

Legal

Privacy policy
Terms of Service
Security

On this page

Prerequisites Install the CLI Create a new project Update Formatting Troubleshooting