942 B
942 B
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.