Click on Use this template to quickstarter your documentation setup with Mintlify. The starter kit contains examples including
- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command
npm i mintlify -g
Run the following command at the root of your documentation (where mint.json is)
mintlify dev
Changes will be deployed to production automatically after pushing to the default branch.
You can also preview changes using PRs, which generates a preview link of the docs.
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Mintlify dev is updating really slowly - Run
mintlify clearto clear the cache.