You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
|
|
## Contribute to these docs
|
|
|
|
|
- Clone this repo
|
|
|
|
|
- install mintlify CLI
|
|
|
|
|
- run mintlify in project directory to get preview of docs
|
|
|
|
|
- make changes
|
|
|
|
|
- push changes
|
|
|
|
|
|
|
|
|
|
### Development
|
|
|
|
|
|
|
|
|
|
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
npm i -g mintlify
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Run the following command at the root of your documentation (where mint.json is)
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
mintlify dev
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
#### 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`
|
