https://github.com/fanweixiao/mintlify-docs
https://github.com/fanweixiao/mintlify-docs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fanweixiao/mintlify-docs
- Owner: fanweixiao
- Created: 2024-05-10T13:03:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-23T03:53:27.000Z (about 1 year ago)
- Last Synced: 2024-05-23T04:57:55.179Z (about 1 year ago)
- Language: MDX
- Size: 1.31 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vivgrid Developer Docs
### 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.
#### 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`