https://github.com/ctrlplanedev/docs
https://github.com/ctrlplanedev/docs
Last synced: 18 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ctrlplanedev/docs
- Owner: ctrlplanedev
- Created: 2025-01-30T21:58:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-11T06:45:26.000Z (10 months ago)
- Last Synced: 2025-04-11T08:47:08.404Z (10 months ago)
- Language: MDX
- Size: 1.88 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Roadmap: roadmap.mdx
Awesome Lists containing this project
README
# 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](https://www.npmjs.com/package/mintlify) 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.
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 install` it'll re-install
dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`