Mintlify Starter Kit - Exploration

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

Workflow

To update/edit documentation, simply open a pull request in this repo. Once merged, it will be automatically deployed.

See the mintlify docs for available features.

Development

Install dependencies

This project uses pnpm and requires Node.js >20.

pnpm i

Run in watch mode

pnpm dev

Open http://localhost:3000 in your browser to view the website.

Checks and tests

To view available tasks, run pnpm run.

To run all CI checks locally, run pnpm check.