Important

📦️ We moved! Come check out our new place over on Codeberg! (Repository link)

We have moved to Codeberg as our primary Git Forge, and the project is alive and well over there! 💜 The GitHub repositories will be archived and potentially deleted in the future.

Website

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

Installation

yarn

Pre-commit Hooks

This project uses pre-commit hooks to ensure code quality and uniform formatting. To set up pre-commit hooks:

1. Install pre-commit:

   pip install pre-commit

2. Install prettier and dev-dependencies:

   yarn install

3. Install the git hooks:

   pre-commit install

The pre-commit hooks will automatically:

• Format Markdown and MDX files using Prettier
• Lint Markdown files using markdownlint
• Check for common issues like trailing whitespace and file endings

You can manually run the checks on all files:

pre-commit run --all-files

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.