This website is built using Docusaurus 2, a modern static website generator.
$ yarn install or npm install
$ yarn start or npm run start
This command starts the local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build or npm build
This command generates static content into the build
directory and can be served using any static contents hosting service.
$ 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.
Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.
$ yarn ci or npm ci