Matt Aitken
35 lines
818 B
Markdown
35 lines
818 B
Markdown
# 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
|
|
|
|
Run these from the root of the repository
|
|
|
|
```
|
|
pnpm install --filter docs
|
|
```
|
|
|
|
```
|
|
pnpm run dev --filter docs
|
|
```
|
|
|
|
Go to http://localhost:3050
|
|
|
|
### 😎 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.
|