docs.mdx 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. ---
  2. title: '📝 Documentation'
  3. description: 'Contribute to Embedchain docs'
  4. ---
  5. <Info>
  6. **Prerequisite** You should have installed Node.js (version 18.10.0 or
  7. higher).
  8. </Info>
  9. Step 1. Install Mintlify on your OS:
  10. <CodeGroup>
  11. ```bash npm
  12. npm i -g mintlify
  13. ```
  14. ```bash yarn
  15. yarn global add mintlify
  16. ```
  17. </CodeGroup>
  18. Step 2. Go to the `docs/` directory (where you can find `mint.json`) and run the following command:
  19. ```bash
  20. mintlify dev
  21. ```
  22. The documentation website is now available at `http://localhost:3000`.
  23. ### Custom Ports
  24. 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:
  25. ```bash
  26. mintlify dev --port 3333
  27. ```
  28. You will see an error like this if you try to run Mintlify in a port that's already taken:
  29. ```md
  30. Error: listen EADDRINUSE: address already in use :::3000
  31. ```
  32. ## Mintlify Versions
  33. Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.
  34. <CodeGroup>
  35. ```bash npm
  36. npm i -g mintlify@latest
  37. ```
  38. ```bash yarn
  39. yarn global upgrade mintlify
  40. ```
  41. </CodeGroup>