Skip to main content
Prerequisite: Please install Node.js (version 19 or higher) before proceeding.
Please upgrade to docs.json before proceeding and delete the legacy mint.json file.
Follow these steps to install and run the documentation locally on your operating system: Step 1: Install DropKit CLI: 
npm i -g @dropkit/docs-cli
Step 2: Navigate to the docs directory (where the docs.json file is located) and execute the following command: 
dropkit-docs dev
A local preview of your documentation will be available at http://localhost:3000.

​
Custom Ports

By default, the DropKit docs CLI uses port 3000. You can customize the port by using the --port flag. To run on port 3333, for instance, use this command: 
dropkit-docs dev --port 3333
If you attempt to run the CLI on a port that’s already in use, it will use the next available port: 
Port 3000 is already in use. Trying 3001 instead.

​
CLI Versions

Please note that each CLI release is associated with a specific version of the documentation system. If your local website doesn’t align with the production version, please update the CLI: 
npm i -g @dropkit/docs-cli@latest
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command: 
dropkit-docs validate-links

​
Deployment

Unlimited editors available under the DropKit Pro Plan and above.
If the deployment is successful, you should see the following:

​
Code Formatting

We suggest using extensions on your IDE to recognize and format MDX. If you’re a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.

​
Troubleshooting

This may be due to an outdated version of node. Try the following:
  1. Remove the currently-installed version of the CLI: npm remove -g @dropkit/docs-cli
  2. Upgrade to Node v19 or higher.
  3. Reinstall the CLI: npm install -g @dropkit/docs-cli
Solution: Go to the root of your device and delete the ~/.dropkit-docs folder. Afterwards, run dropkit-docs dev again.
Curious about what changed in the CLI version? Check out the CLI changelog.