| 1 | # Mintlify Starter Kit |
| 2 | |
| 3 | Use the starter kit to get your docs deployed and ready to customize. |
| 4 | |
| 5 | 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 |
| 6 | |
| 7 | - Guide pages |
| 8 | - Navigation |
| 9 | - Customizations |
| 10 | - API reference pages |
| 11 | - Use of popular components |
| 12 | |
| 13 | **[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)** |
| 14 | |
| 15 | ## AI-assisted writing |
| 16 | |
| 17 | Set up your AI coding tool to work with Mintlify: |
| 18 | |
| 19 | ```bash |
| 20 | npx skills add https://mintlify.com/docs |
| 21 | ``` |
| 22 | |
| 23 | 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. |
| 24 | |
| 25 | See the [AI tools guides](/ai-tools) for tool-specific setup. |
| 26 | |
| 27 | ## Development |
| 28 | |
| 29 | Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command: |
| 30 | |
| 31 | ``` |
| 32 | npm i -g mint |
| 33 | ``` |
| 34 | |
| 35 | Run the following command at the root of your documentation, where your `docs.json` is located: |
| 36 | |
| 37 | ``` |
| 38 | mint dev |
| 39 | ``` |
| 40 | |
| 41 | View your local preview at `http://localhost:3000`. |
| 42 | |
| 43 | ## Publishing changes |
| 44 | |
| 45 | Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch. |
| 46 | |
| 47 | ## Need help? |
| 48 | |
| 49 | ### Troubleshooting |
| 50 | |
| 51 | - If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI. |
| 52 | - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`. |
| 53 | |
| 54 | ### Resources |
| 55 | - [Mintlify documentation](https://mintlify.com/docs) |