tree: 03ca1cc5b1c2c5bcca7a4ced5ead3ddfaac47ee3 [path history] [tgz]
  1. docs/
  2. scripts/
  3. src/
  4. static/
  5. versioned_docs/
  6. versioned_sidebars/
  7. .gitignore
  8. babel.config.js
  9. docusaurus.config.js
  10. package.json
  11. README.md
  12. sidebars.json
  13. versions.json
  14. yarn.lock
site3/website/README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.