npm run dev
npm run build
If you want to add a document, please do the following things:
- Add a new
.mdfile in this repo.
- Add the corresponding other language version of the doc, if necessary.
- Update sidebar manu in ./.vuepress/locales/en.ts
We are using GitHub actions to build & publish docs. Once the
main branch is pushed to GitHub,
deploy action will do the following things:
- Fetch the latest version of code
- Install dependencies
- Build docs
- Deploy docs under
.vuepress/distto GitHub pages, with target branch
If we moved a doc to a more proper place and want to keep the old route working, then we need
<Redirect> is a component registered locally, you can simply put it in the old doc, and users visiting the old doc will be redirected to the new doc.
// /path-to/legacy-doc.md <Redirect to="/path-to/new-doc.md"/>
In the example above, when users enter
/path-to/legacy-doc, they will be redirected to
/path-to/new-doc automatically. In this way, we can keep the legacy path work.