History

Jerome Wu cecc63219a Update usage		2023-07-26 22:41:27 +08:00
..
blog	Complete first blog post	2023-07-26 06:32:31 +00:00
docs	Update usage	2023-07-26 22:41:27 +08:00
src	Fix SSR issue	2023-07-26 04:57:39 +00:00
static	Update usage	2023-07-26 00:23:09 +08:00
.gitignore	Revert .gitignore	2022-10-08 09:36:41 +08:00
babel.config.js	Update CI and add website	2022-10-05 14:44:56 +08:00
docusaurus.config.js	Fix api docs	2023-07-26 22:24:38 +08:00
package.json	Update website scripts	2023-07-26 01:38:24 +00:00
README.md	Add git-lfs in README.md	2023-07-26 08:29:44 +00:00
sidebars.js	Fix api docs	2023-07-26 22:24:38 +08:00
tsconfig.json	Update CI and add website	2022-10-05 14:44:56 +08:00

README.md

Website

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

Installation

When cloning the repository, make sure you have git-lfs installed. If you install git-lfs after cloning, simple run git lfs pull to download large files.

$ npm install

Local Development

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

$ npm run 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 npm run deploy

Not using SSH:

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