Self-updating documentation for startups, enterprises, and agents.
mint dev to preview your docs locally before pushing to production.mint.json require a server restart to take effect.Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git.
Install the Mintlify CLI globally.
$ npm i -g mint
Clone your repository and preview locally.
$ git clone <your-repository-url>
$ mint dev
Push to deploy — changes go live automatically.
$ git add . && git commit -m "Update docs"
$ git push
http://localhost:3000 to preview your docs locally before pushing changes.
Mintlify supports multiple authentication methods for restricting access to your documentation. Protect internal content with JWT, OAuth, or password gating.
Add an auth field to your mint.json configuration:
{
"auth": {
"method": "jwt",
"headerName": "Authorization"
}
}
The Mintlify CLI lets you develop and preview your documentation locally with hot reloading.
Node.js 18 or later. Install globally via npm:
$ npm i -g mint
$ mint --version
mint upgrade to update the CLI to the latest version.
The mint.json file at your repository root controls all site configuration.
{
"name": "Acme Docs",
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"primaryTab": { "name": "Docs" },
"navigation": [
{
"group": "Getting Started",
"pages": ["quickstart", "installation"]
}
]
}
Mintlify uses MDX — Markdown with JSX — so you can embed components directly in your documentation pages.
---
title: "Introduction"
description: "Your custom description here"
---
Welcome to your new documentation site.
Mintlify ships built-in components for callouts, tabs, cards, code groups, steps, and more — use them directly in MDX without any imports.
<Callout type="tip">
Use components to make your docs interactive.
</Callout>
<Card title="Quickstart" icon="bolt" href="/quickstart">
Get up and running in minutes.
</Card>
Code blocks support syntax highlighting for 100+ languages, optional line numbers, line highlights, and a copy-to-clipboard button.
```bash title="Install dependencies"
npm i -g mint
```
```typescript title="mintlify.config.ts"
export default {
name: 'My Docs',
primaryTab: { name: 'Docs' },
}
```
Auto-generate beautiful API reference pages from an OpenAPI spec. Mintlify renders request/response schemas, authentication details, and a live playground.
"openapi": "openapi.yaml"
Mintlify sends webhook events for page views, AI searches, and feedback submissions. Subscribe from your project dashboard under Settings → Webhooks.
Available events: page.viewed, search.performed, feedback.submitted.
#fefdfb as the light mode page background — the warm off-white is Mintlify's most distinctive visual signature#18e299 in dark mode and #0c8c5e in light mode — the two values are not interchangeable#ffffff) as the main page background in light mode — the warm cream is intentional#18e299 directly on a light background — it fails WCAG contrast requirements#18E299 / #0C8C5E is fixed in the SVG and must not change