Merge pull request #4663 from Infisical/fix/docs-dev-command

fix: docs dev command
This commit is contained in:
Piyush Gupta
2025-10-14 01:11:07 +05:30
committed by GitHub
2 changed files with 10 additions and 10 deletions

View File

@@ -1,24 +1,24 @@
# Contributing to the documentation
## Getting familiar with Mintlify
New to Mintlify. [Start Here](https://mintlify.com/docs/quickstart)
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
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 mintlify
npm i -g mint
```
Run the following command at the root of your documentation (where mint.json is)
```
mintlify dev
mint dev
```
## Troubleshooting
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- `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

View File

@@ -43,23 +43,23 @@ docker compose -f docker-compose.dev.yml down
We use [Mintlify](https://mintlify.com/) for our docs.
#### Install Mintlify CLI.
#### Install Mint CLI.
```bash
npm i -g mintlify
npm i -g mint
```
or
```bash
yarn global add mintlify
yarn global add mint
```
#### Running the docs
Go to `docs` directory and run `mintlify dev`. This will start up the docs on `localhost:3000`
Go to `docs` directory and run `mint dev`. This will start up the docs on `localhost:3000`
```bash
# From the root directory
cd docs; mintlify dev;
cd docs; mint dev;
```