History

James Wyndham 5c9d64792c feature - updated favicon		2024-03-13 16:26:52 +08:00
..
docs	feature - changed to docs	2024-03-13 16:23:40 +08:00
src	feature - changed to docs	2024-03-13 16:23:40 +08:00
static	feature - updated favicon	2024-03-13 16:26:52 +08:00
.gitignore	feature - changed to docs	2024-03-13 16:23:40 +08:00
README.md	feature - changed to docs	2024-03-13 16:23:40 +08:00
babel.config.js	feature - changed to docs	2024-03-13 16:23:40 +08:00
docusaurus.config.ts	feature - changed to docs	2024-03-13 16:23:40 +08:00
package-lock.json	feature - changed to docs	2024-03-13 16:23:40 +08:00
package.json	feature - changed to docs	2024-03-13 16:23:40 +08:00
sidebars.ts	feature - changed to docs	2024-03-13 16:23:40 +08:00
tsconfig.json	feature - changed to docs	2024-03-13 16:23:40 +08:00

Website

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

$ yarn

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

$ yarn 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 yarn deploy

Not using SSH:

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