Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

  • Guide pages
  • Navigation
  • Customizations
  • API Reference pages
  • Use of popular components

๐Ÿ‘ฉโ€๐Ÿ’ป Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

๐Ÿ˜Ž Publishing Changes

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.

Troubleshooting

  • Mintlify dev isnโ€™t running - Run mintlify install itโ€™ll re-install dependencies.
  • Page loads as a 404 - Make sure you are running in a folder with mint.json

Was this page helpful?