History

jeromewu a1edcd9d92 Fix SSR issue		2023-07-26 04:57:39 +00:00
..
blog	Refactor playground page and init docs	2022-10-08 16:10:15 +08:00
docs	Update usage.md with imports	2023-07-26 00:32:13 +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 SSR issue	2023-07-26 04:57:39 +00:00
package.json	Update website scripts	2023-07-26 01:38:24 +00:00
README.md	Update website	2023-07-24 23:57:29 +08:00
sidebars.js	Complete overview page	2023-07-25 22:45:02 +08:00
tsconfig.json	Update CI and add website	2022-10-05 14:44:56 +08:00

Website

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

$ npm install

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

$ npm run build

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

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.