https://github.com/rockchinq/mintlify-docs
https://github.com/rockchinq/mintlify-docs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rockchinq/mintlify-docs
- Owner: RockChinQ
- Created: 2025-08-07T04:09:33.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-07T04:13:58.000Z (2 months ago)
- Last Synced: 2025-08-07T06:17:45.173Z (2 months ago)
- Language: MDX
- Size: 347 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mintlify Starter Kit
Use the starter kit to get your docs deployed and ready to customize.
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with:
- Guide pages
- Navigation
- Customizations
- API reference pages
- Use of popular components
[**Follow the full quickstart guide**](https://starter.mintlify.com/quickstart)
## Development
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
```
npm i -g mint
```
Run the following command at the root of your documentation, where your `docs.json` is located:
```
mint dev
```
View your local preview at `http://localhost:3000`.
## Publishing changes
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
## Need help?
### Troubleshooting
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
### Resources
- [Mintlify documentation](https://mintlify.com/docs)
- [Mintlify community](https://mintlify.com/community)