Chapter: README (docs/README.md) Copy Section

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 Copy Section

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

npm i mintlify

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

mintlify dev

Publishing Changes Copy Section

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. You can find the installation link on your dashboard.

#### Troubleshooting

- Mintlify Dev isn't running - Run mintlify install it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with mint.json