Awesome
Website
This website is built using Docusaurus 3, a modern static website generator.
Installation
$ yarn
On Windows machines, you might encounter a security error when running yarn
:
You cannot run this script on the current system. For more information about running scripts and setting execution policy, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170.
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
This sets the execution policy to "Bypass" for the current session and allows the installation to proceed without errors on Windows.
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
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.