repositories
loading repo index
repositories
loading repo index
repository
loading code, commits, and activity
public Clawd ADK gateway launch mirror
stars
latest
clone command
git clone gitlawb://did:key:z6Mkq5mY...iFZ5/my-project-publ...git clone gitlawb://did:key:z6Mkq5mY.../my-project-publ...2fa351d6docs: add automaton and perps launch sources16d ago| #1 | --- |
| #2 | title: '📝 Documentation' |
| #3 | description: 'Contribute to Embedchain docs' |
| #4 | --- |
| #5 | |
| #6 | <Info> |
| #7 | **Prerequisite** You should have installed Node.js (version 18.10.0 or |
| #8 | higher). |
| #9 | </Info> |
| #10 | |
| #11 | Step 1. Install Mintlify on your OS: |
| #12 | |
| #13 | <CodeGroup> |
| #14 | |
| #15 | ```bash npm |
| #16 | npm i -g mintlify |
| #17 | ``` |
| #18 | |
| #19 | ```bash yarn |
| #20 | yarn global add mintlify |
| #21 | ``` |
| #22 | |
| #23 | </CodeGroup> |
| #24 | |
| #25 | Step 2. Go to the `docs/` directory (where you can find `mint.json`) and run the following command: |
| #26 | |
| #27 | ```bash |
| #28 | mintlify dev |
| #29 | ``` |
| #30 | |
| #31 | The documentation website is now available at `http://localhost:3000`. |
| #32 | |
| #33 | ### Custom Ports |
| #34 | |
| #35 | 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: |
| #36 | |
| #37 | ```bash |
| #38 | mintlify dev --port 3333 |
| #39 | ``` |
| #40 | |
| #41 | You will see an error like this if you try to run Mintlify in a port that's already taken: |
| #42 | |
| #43 | ```md |
| #44 | Error: listen EADDRINUSE: address already in use :::3000 |
| #45 | ``` |
| #46 | |
| #47 | ## Mintlify Versions |
| #48 | |
| #49 | Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production. |
| #50 | |
| #51 | <CodeGroup> |
| #52 | |
| #53 | ```bash npm |
| #54 | npm i -g mintlify@latest |
| #55 | ``` |
| #56 | |
| #57 | ```bash yarn |
| #58 | yarn global upgrade mintlify |
| #59 | ``` |
| #60 | |
| #61 | </CodeGroup> |
| #62 |