https://github.com/Brandfetch/old-doc-example
https://github.com/Brandfetch/old-doc-example
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Brandfetch/old-doc-example
- Owner: Brandfetch
- Created: 2023-01-19T17:30:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-19T17:30:24.000Z (about 2 years ago)
- Last Synced: 2024-08-13T07:03:32.304Z (8 months ago)
- Size: 6.38 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - Brandfetch/old-doc-example - (Others)
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
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.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`