mirror of
https://github.com/gogs/gogs.git
synced 2026-02-19 04:47:05 +01:00
27 lines
670 B
Markdown
27 lines
670 B
Markdown
|
## Development
|
||
|
|
|
||
|
|
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
|
||
|
|
|
||
|
|
```
|
||
|
|
pnpm i -g mint
|
||
|
|
```
|
||
|
|
|
||
|
|
Run the following command at the root of your documentation, where your `docs.json` is located:
|
||
|
|
|
||
|
|
```
|
||
|
|
mint dev
|
||
|
|
```
|
||
|
|
|
||
|
|
View your local preview at `http://localhost:3000`.
|
||
|
|
|
||
|
|
## Need help?
|
||
|
|
|
||
|
|
### Troubleshooting
|
||
|
|
|
||
|
|
- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
|
||
|
|
- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
|
||
|
|
|
||
|
|
### Resources
|
||
|
|
|
||
|
|
- [Mintlify documentation](https://mintlify.com/docs)
|