my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: 'Development'
#3	description: 'Learn how to preview changes locally'
#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 are located (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
#63	## Deployment
#64
#65	<Tip>
#66	Unlimited editors available under the [Startup
#67	Plan](https://mintlify.com/pricing)
#68	</Tip>
#69
#70	You should see the following if the deploy successfully went through:
#71
#72	<Frame>
#73	<img src="/images/checks-passed.png" style={{ borderRadius: '0.5rem' }} />
#74	</Frame>
#75
#76	## Troubleshooting
#77
#78	Here's how to solve some common problems when working with the CLI.
#79
#80	<AccordionGroup>
#81	<Accordion title="Mintlify is not loading">
#82	Update to Node v18. Run `mintlify install` and try again.
#83	</Accordion>
#84	<Accordion title="No such file or directory on Windows">
#85	Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint`
#86	folder. Then Open the Git Bash in this location and run `git clone
#87	https://github.com/mintlify/mint.git`.
#88
#89	Repeat step 3.
#90
#91	</Accordion>
#92	<Accordion title="Getting an unknown error">
#93	Try navigating to the root of your device and delete the ~/.mintlify folder.
#94	Then run `mintlify dev` again.
#95	</Accordion>
#96	</AccordionGroup>
#97
#98	Curious about what changed in a CLI version? [Check out the CLI changelog.](/changelog/command-line)
#99

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public