Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

Guide pages
Navigation
Customizations
API Reference pages
Use of popular components

Development

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

npm i -g mint

Run the following command at the root of your documentation (where docs.json is)

mint dev

Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

Troubleshooting

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!