Diff of
/docs/README.md
[000000]
..
[1bdb11]
Switch to unified view
| a | b/docs/README.md | ||
|---|---|---|---|
| 1 | # Mintlify Starter Kit |
||
| 2 | |||
| 3 | Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including |
||
| 4 | |||
| 5 | - Guide pages |
||
| 6 | - Navigation |
||
| 7 | - Customizations |
||
| 8 | - API Reference pages |
||
| 9 | - Use of popular components |
||
| 10 | |||
| 11 | ### Development |
||
| 12 | |||
| 13 | Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command |
||
| 14 | |||
| 15 | ``` |
||
| 16 | npm i -g mintlify |
||
| 17 | ``` |
||
| 18 | |||
| 19 | Run the following command at the root of your documentation (where mint.json is) |
||
| 20 | |||
| 21 | ``` |
||
| 22 | mintlify dev |
||
| 23 | ``` |
||
| 24 | |||
| 25 | ### Publishing Changes |
||
| 26 | |||
| 27 | 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. |
||
| 28 | |||
| 29 | #### Troubleshooting |
||
| 30 | |||
| 31 | - Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. |
||
| 32 | - Page loads as a 404 - Make sure you are running in a folder with `mint.json` |