History

Timon b941108cbd chore: update documentation to use mise commands (#28515 )		2026-05-27 10:33:23 -04:00
..
docs	chore: update documentation to use mise commands (#28515 )	2026-05-27 10:33:23 -04:00
src	feat: schema-check (#25904 )	2026-02-12 17:59:00 -05:00
static	chore: version v2.7.5	2026-04-13 14:27:31 +00:00
.gitignore	docs: include openapi.json (#20760 )	2025-08-07 12:00:50 -05:00
.prettierignore	ci: doc format check (#2325 )	2023-04-24 12:49:20 -05:00
.prettierrc	ci: doc format check (#2325 )	2023-04-24 12:49:20 -05:00
README.md	chore: update docs to use pnpm (#21113 )	2025-08-21 15:25:05 -05:00
babel.config.js	Change documentation folder to docs	2022-10-27 21:44:37 -05:00
docusaurus.config.js	chore: handle docusaurus deprecation warning (#28516 )	2026-05-20 15:27:33 +02:00
mise.lock	feat: use lockfile for mise tools (#28503 )	2026-05-20 11:37:33 +00:00
mise.toml	chore: update documentation to use mise commands (#28515 )	2026-05-27 10:33:23 -04:00
package.json	chore: use mise (#28298 )	2026-05-08 15:21:33 -04:00
sidebars.js	ci: doc format check (#2325 )	2023-04-24 12:49:20 -05:00
tailwind.config.js	docs: update documentation (#25440 )	2026-01-25 15:45:30 +00:00
tsconfig.json	chore(deps): update dependency typescript to v6 (#27577 )	2026-04-07 17:15:55 +02:00

Website

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

$ pnpm install

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

$ pnpm run 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 pnpm run deploy

Not using SSH:

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