https://github.com/ayushexel/mint-docs
https://github.com/ayushexel/mint-docs
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ayushexel/mint-docs
- Owner: AyushExel
- Created: 2023-01-02T09:40:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-02T09:40:03.000Z (over 2 years ago)
- Last Synced: 2025-02-08T09:38:13.018Z (3 months ago)
- Size: 6.38 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mintlify Starter Kit
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
### 👩💻 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 mintlify -g
```
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.
- Mintlify dev is updating really slowly - Run `mintlify clear` to clear the cache.