1
0
mirror of https://github.com/Infisical/infisical.git synced 2025-03-22 11:45:48 +00:00

Merge pull request from afrieirham/docs/running-docs-locally

docs: add running infisical docs locally guide
This commit is contained in:
Maidul Islam
2023-07-24 09:00:46 -04:00
committed by GitHub

@ -82,4 +82,28 @@ Password: `testInfisical1`
```bash
# To stop environment use Control+C (on Mac) CTRL+C (on Win) or
docker-compose -f docker-compose.dev.yml down
```
## Starting Infisical docs locally
We use [Mintlify](https://mintlify.com/) for our docs.
#### Install Mintlify CLI.
```bash
npm i -g mintlify
```
or
```bash
yarn global add mintlify
```
#### Running the docs
Go to `docs` directory and run `mintlify dev`. This will start up the docs on `localhost:3000`
```bash
# From the root directory
cd docs; mintlify dev;
```