Source for kusionstack.io site https://kusionstack.io.
Powered by Docusaurus 2.
Write documentation for sub products in the ./docs/[subProductNmae]
directory.
$ rm -rf .docusaurus
$ npm install
$ npm run start
Open http://localhost:3000 in the browser.
$ npm run build
$ npx http-server ./build
Open http://localhost:8080 in the browser.
- First, make sure the current docs version (the
./docs/[subProductNmae]
directory) is ready to be frozen. - Enter the specified sub product name and a new version number:
npm run docusaurus docs:version:[subProductNmae] [vMAJOR.MINOR]
Example:
npm run docusaurus docs:version:docs v0.12
npm run docusaurus docs:version:ctrlmesh v0.3
npm run docusaurus docs:version:ctrlmesh v0.1
Optional sub product names:
docs
(alias for kusion)operating
ctrlmesh
Format of version number: [vMAJOR.MINOR]
, e.g. v0.3
, v0.13
.
When tagging a new version of sub product, the document versioning mechanism will:
- Copy the full
docs/[subProductNmae]
folder contents into a new[subProductNmae]_versioned_docs/version-[versionName]/
folder. - Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as
[subProductNmae]_versioned_sidebars/version-[versionName]-sidebars.json
. - Append the new version number to
[subProductNmae]_versions.json
.
More see:
This website is built under Docusaurus version 2.4.1. There may be unknown errors when compiling on other versions.