chao 3ee85dccfa first 6 months ago
..
docs 3ee85dccfa first 6 months ago
scripts 3ee85dccfa first 6 months ago
src 3ee85dccfa first 6 months ago
static 3ee85dccfa first 6 months ago
.gitignore 3ee85dccfa first 6 months ago
README.md 3ee85dccfa first 6 months ago
babel.config.js 3ee85dccfa first 6 months ago
docusaurus.config.js 3ee85dccfa first 6 months ago
package.json 3ee85dccfa first 6 months ago
sidebars.js 3ee85dccfa first 6 months ago

README.md

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

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.