b33ff31c2a
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| static | ||
| versioned_docs/version-21.5.0 | ||
| versioned_sidebars | ||
| archive.js | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| versions.json | ||
| versionsArchived.json | ||
Website
This website is built using Docusaurus 2.
Installation
$ npm install
Local Development
$ npm start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true npm run deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> npm run deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.