Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

Click the green Use this template button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

• Guide pages
• Navigation
• Customizations
• API reference pages
• Use of popular components

Follow the full quickstart guide

AI-assisted writing

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

AI-native workflow

This repo is set up so any AI coding agent gets the same context automatically:

• AGENTS.md — project terminology, style rules, the add-a-page workflow, and an inventory of the available agent tooling. CLAUDE.md imports it so Claude Code and Codex share one source of truth.
• .mcp.json — wires in the Mintlify editing MCP (mcp.mintlify.com) and docs-knowledge MCP so agents can edit content and look up Mintlify usage without manual setup.
• .claude/hooks/session-start.sh — installs the mint CLI in Claude Code on the web sessions so agents can preview (mint dev) and validate (mint broken-links) docs.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

Need help?

Troubleshooting

• If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources

• Mintlify documentation