grmdocs
GuidesAPI reference
Getting started

Development

Preview changes locally to update your docs

Prerequisites:

  • Node.js version 19 or higher
  • A docs repository with a docs.json file

Follow these steps to install and run MinimalDocs on your operating system.

Install the MinimalDocs CLI

Preview locally

Navigate to your docs directory where your docs.json file is located, and run the following command:

A local preview of your documentation will be available at http://localhost:3000.

Custom ports

By default, MinimalDocs uses port 3000. You can customize the port MinimalDocs runs on by using the --port flag. For example, to run MinimalDocs on port 3333, use this command:

If you attempt to run MinimalDocs on a port that's already in use, it will use the next available port:

MinimalDocs versions

Please note that each CLI release is associated with a specific version of MinimalDocs. If your local preview does not align with the production version, please update the CLI:

Validating links

The CLI can assist with validating links in your documentation. To identify any broken links, use the following command:

Deployment

If the deployment is successful, you should see the following:

Screenshot of a deployment confirmation message that says All checks have passed.

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 minimaldocs
  2. Upgrade to Node v19 or higher.
  3. Reinstall the CLI: npm i -g minimaldocs

Solution: Go to the root of your device and delete the ~/.minimaldocs folder. Then run minimaldocs dev again.

Curious about what changed in the latest CLI version? Check out the CLI changelog.