docs: rebuild v2 documentation
This commit is contained in:
parent
4e019ba5d9
commit
e6e951b252
27 changed files with 264 additions and 1689 deletions
|
|
@ -1,44 +1,24 @@
|
|||
# Mintlify Starter Kit
|
||||
# OpenCode documentation
|
||||
|
||||
Use the starter kit to get your docs deployed and ready to customize.
|
||||
The V2 documentation is a Mintlify site deployed from `packages/docs` on the `dev` branch.
|
||||
|
||||
Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
|
||||
## Local preview
|
||||
|
||||
- Guide pages
|
||||
- Navigation
|
||||
- Customizations
|
||||
- API reference pages
|
||||
- Use of popular components
|
||||
The Mintlify CLI requires Node.js 20 through 24.
|
||||
|
||||
**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**
|
||||
From this directory, run:
|
||||
|
||||
## Development
|
||||
|
||||
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
|
||||
|
||||
```
|
||||
npm i -g mint
|
||||
```bash
|
||||
npx mint dev
|
||||
```
|
||||
|
||||
Run the following command at the root of your documentation, where your `docs.json` is located:
|
||||
The preview opens at `http://localhost:3000` and reloads when MDX or `docs.json` changes.
|
||||
|
||||
```
|
||||
mint dev
|
||||
Validate changes before opening a pull request:
|
||||
|
||||
```bash
|
||||
npx mint validate
|
||||
npx mint broken-links
|
||||
```
|
||||
|
||||
View your local preview at `http://localhost:3000`.
|
||||
|
||||
## Publishing changes
|
||||
|
||||
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
|
||||
|
||||
## 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)
|
||||
The hosted preview is available at [opencode.mintlify.site](https://opencode.mintlify.site).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue