Spaces:
No application file
No application file
title: 'π Documentation' | |
description: 'Contribute to Embedchain docs' | |
<Info> | |
**Prerequisite** You should have installed Node.js (version 18.10.0 or | |
higher). | |
</Info> | |
Step 1. Install Mintlify on your OS: | |
<CodeGroup> | |
```bash npm | |
npm i -g mintlify | |
``` | |
```bash yarn | |
yarn global add mintlify | |
``` | |
</CodeGroup> | |
Step 2. Go to the `docs/` directory (where you can find `mint.json`) and run the following command: | |
```bash | |
mintlify dev | |
``` | |
The documentation website is now available at `http://localhost:3000`. | |
### Custom Ports | |
Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333: | |
```bash | |
mintlify dev --port 3333 | |
``` | |
You will see an error like this if you try to run Mintlify in a port that's already taken: | |
```md | |
Error: listen EADDRINUSE: address already in use :::3000 | |
``` | |
## Mintlify Versions | |
Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. | |
<CodeGroup> | |
```bash npm | |
npm i -g mintlify@latest | |
``` | |
```bash yarn | |
yarn global upgrade mintlify | |
``` | |
</CodeGroup> | |