mirror of
https://github.com/Infisical/infisical.git
synced 2026-05-02 03:02:03 -04:00
25 lines
662 B
Markdown
25 lines
662 B
Markdown
# Contributing to the documentation
|
|
|
|
## Getting familiar with Mintlify
|
|
New to Mintlify. [Start Here](https://mintlify.com/docs/quickstart)
|
|
|
|
|
|
## 👩💻 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`. Check the `/docs` folder
|