# Mintlify — AI-Powered Documentation Platform

> Beautiful API docs and developer portals with AI-powered search, auto-generated API references, and instant deployment from markdown or OpenAPI specs.

## Install

Save in your project root:

## Quick Use

```bash
npx mintlify dev
```

Preview docs locally at `localhost:3000`. Push to GitHub and Mintlify deploys automatically.

## What is Mintlify?

Mintlify is a modern documentation platform built for developer tools. It turns markdown files into polished documentation sites with built-in AI search, API playground, and analytics — no frontend work needed.

**Answer-Ready**: Mintlify is an AI-native documentation platform that generates beautiful developer docs from markdown with built-in search, analytics, and API playgrounds.

## Core Features

### 1. Markdown-First Authoring
Write docs in MDX with rich components:

```mdx
---
title: 'Getting Started'
description: 'Set up your project in 5 minutes'
---

<Card title="Quick Start" icon="rocket" href="/quickstart">
  Get up and running in minutes
</Card>

<CodeGroup>
```bash npm
npm install @acme/sdk
```
```bash yarn
yarn add @acme/sdk
```
</CodeGroup>
```

### 2. Auto API Reference
Point to your OpenAPI spec:

```json
// mint.json
{
  "openapi": "https://api.example.com/openapi.json",
  "api": {
    "baseUrl": "https://api.example.com",
    "auth": { "method": "bearer" }
  }
}
```

### 3. AI-Powered Search
Built-in semantic search answers user questions directly from your docs — no configuration needed.

### 4. Analytics Dashboard
Track which pages users visit, what they search for, and where they drop off.

## FAQ

**Q: Is Mintlify free?**
A: Free tier for open-source projects. Paid plans start at $150/mo for startups.

**Q: Can I self-host?**
A: Mintlify is cloud-hosted. For self-hosting needs, consider Docusaurus or Nextra.

**Q: Does it support versioning?**
A: Yes, multi-version docs are supported on Growth plans and above.

## Source & Thanks

- Official site: [mintlify.com](https://mintlify.com)
- GitHub: [mintlify/mintlify](https://github.com/mintlify/mintlify)
- Used by: Anthropic, Cursor, Resend, Trigger.dev

<!-- ZH -->

## 快速使用

```bash
npx mintlify dev
```

本地预览文档，推送到 GitHub 即自动部署。

## 什么是 Mintlify？

Mintlify 是面向开发者工具的现代文档平台。将 Markdown 文件转化为精美文档站点，内置 AI 搜索、API 游乐场和数据分析——无需前端开发。

**一句话总结**：Mintlify 是 AI 原生文档平台，从 Markdown 生成精美开发者文档，内置搜索、分析和 API 交互功能。

## 核心功能

### 1. Markdown 优先
用 MDX 编写，支持丰富的内置组件（卡片、代码组、标签页等）。

### 2. 自动 API 文档
指向 OpenAPI 规范，自动生成可交互的 API 参考文档。

### 3. AI 搜索
内置语义搜索，直接从文档内容回答用户问题。

### 4. 数据分析
追踪页面访问、搜索关键词和用户流失点。

## 常见问题

**Q: 免费吗？**
A: 开源项目免费，付费计划从 $150/月起。

**Q: 支持自托管吗？**
A: 仅云托管。需要自托管可选 Docusaurus 或 Nextra。

## 来源与致谢

- 官网：[mintlify.com](https://mintlify.com)
- 被 Anthropic、Cursor、Resend 等团队使用

---
Source: https://tokrepo.com/en/workflows/9dd15b95-210b-493d-8ebf-0c704a1a1b7a
Author: Skill Factory