Install Now
docs
A starter kit designed for creating and managing project documentation with features like guide pages, navigation, and API references. It facilitates local previews and automatic deployment of documentation changes through a GitHub app integration.
Author
jiawei0816
Quick Info
GitHub Stars 0
Weekly Downloads 0Actions
Tags
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
Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Troubleshooting
- Mintlify dev isn't running - Run
mintlify installit'll re-install dependencies. - Page loads as a 404 - Make sure you are running in a folder with
mint.json
PNG Icons
