Skip to main content
Mintlify helps you create, customize, and publish documentation that your users will actually want to read. Write content in MDX files, configure your site in docs.json, and Mintlify handles the hosting, search, and deployment automatically whenever you push to GitHub.

Quick Start

Get your docs site running in three steps.

Local Development

Preview changes locally with the Mintlify CLI.

Customize Your Site

Set your brand colors, logo, and site name.

API Reference

Auto-generate API docs from OpenAPI specs.

​
How Mintlify works

Mintlify takes your MDX files and docs.json configuration from a GitHub repository and publishes them as a fully hosted documentation site. There is no build step to manage and no servers to configure.
1

Connect your repo

Sign in at dashboard.mintlify.com and connect your GitHub repository. Mintlify installs a GitHub App that watches for changes.
2

Write your docs

Add .mdx files to your repository and update docs.json to add them to the navigation. Preview changes locally with mint dev.
3

Push and go live

Commit and push your changes. Mintlify automatically builds and deploys your updated docs site within seconds.

​
Key features

MDX authoring

Write rich documentation with Markdown, React components, and interactive code examples.

Navigation control

Organize pages into tabs and groups with a simple JSON configuration.

Reusable snippets

Define content once and reuse it across multiple pages.

AI tool integrations

Use Cursor, Claude Code, or Windsurf to write and edit your docs with AI assistance.