This repository has been archived by the owner on Dec 23, 2022. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To build new docs, you'll need to have Node.js and Yarn installed on your system, and run:
in
docs-src/
.Docs will be built into
docs
, where GitHub Pages treated as site root. So be sure to commitdocs
changes.CI/CD is not included in this PR, so manual build is required after every docs update.
yarn dev
runs a local hot-reload-enabled docs server for easier debugging.In the long run, using some 3rd-party static hosting like Netlify would be easier to release docs.
Docs engine is based on VuePress.