docs.json file, and Mintlify handles the rest: hosting, search, API reference generation, and more. This page gives you a quick overview of what Mintlify offers and points you to everything you need to get started.
Get Started
Jump straight into building your docs with these essentials:Quick Start
Get your documentation site up and running in minutes. Create your first page and publish it to the world.
Local Development
Preview your changes locally before you push. Install the Mintlify CLI and run a live dev server on your machine.
Customization
Make your docs feel like your product. Set brand colors, upload your logo, and structure your navigation exactly how you want it.
API Reference
Auto-generate a beautiful, interactive API reference directly from your OpenAPI specification — no manual upkeep required.
Key Features
Everything you need to ship documentation your users will love:MDX-Based Content
Write in Markdown with the full power of React components. Mix prose, code blocks, callouts, and custom UI — all in plain
.mdx files you own.OpenAPI-Powered API Docs
Point Mintlify at your OpenAPI spec and get a fully interactive API reference with live request/response examples — generated automatically and always in sync.
GitHub Auto-Deploy
Push to your repository and your docs update instantly. Mintlify integrates directly with GitHub so every merge to
main triggers a live deployment — no CI pipelines to configure.AI Writing Tools
Write faster with built-in AI assistance. Mintlify’s AI tools help you draft new content, improve clarity, and keep your documentation consistent as your product evolves.
Next Steps
Follow these three steps to go from zero to published docs:1
Clone Your Docs Repo
Open the Mintlify dashboard, create a new project, and clone the generated repository to your local machine. Your starter content and
docs.json configuration are ready to go.2
Install the CLI and Preview Locally
Install the Mintlify CLI with
npm i -g mint, then run mint dev in your docs directory. A live preview opens in your browser and hot-reloads as you edit.3
Push to Deploy
When you’re happy with your changes, commit and push to your
main branch. Mintlify detects the push and publishes your updated docs automatically — no extra steps needed.