Submarine Website

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

Installation

# We recommend using node 18(LTS). 
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.