tree: 6d22fd5ef95f165fee3e3e4ab961e6d0e4d38524 [path history] [tgz]
  1. docs/
  2. i18n/
  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.js
  13. versions.json
  14. versionsReleaseNoteOnly.json
  15. yarn.lock
website/README.md

Submarine Website

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

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

If you want to switch to zh-cn, you can use the following command to start.

yarn start -- --locale zh-cn

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true 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.