This website is built using Docusaurus, a modern static website generator.
Install the Required Packages
yarn
Install Pre-commit Hook To set up Git pre-commit hooks, you first need to install the pre-commit tool. Follow the instructions in the official documentation.
pre-commit install
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.
npm run markdownlint
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.