mirror of
https://github.com/Infisical/infisical.git
synced 2026-01-10 07:58:15 -05:00
25 lines
632 B
Markdown
25 lines
632 B
Markdown
# Contributing to the documentation
|
|
|
|
## Getting familiar with Mintlify
|
|
|
|
New to Mintlify. [Start Here](https://mintlify.com/docs/quickstart)
|
|
|
|
## 👩💻 Development
|
|
|
|
Install the [Mint CLI](https://www.npmjs.com/package/mint) 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 mint.json is)
|
|
|
|
```
|
|
mint dev
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
- `mint dev` isn't running - Run `mint update` to update the Mint CLI.
|
|
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`. Check the `/docs` folder
|