This website is built using Docusaurus, a modern static website generator.
pnpm installpnpm run startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
The site is available in English (default), French (fr) and German (de). The development server only serves one locale at a time, so switching language with the locale dropdown leads to a "Page not found". To work on a translation, start the server with its locale:
pnpm run start --locale fr # or --locale deTo try the locale dropdown with all languages, build the site and serve it:
pnpm run build
pnpm run serveTranslations live in i18n/<locale>/ (i18n/fr/, i18n/de/):
| Path | Content |
|---|---|
docusaurus-plugin-content-blog/ |
blog posts and tags.yml |
docusaurus-plugin-content-docs/current/ |
documentation pages |
docusaurus-theme-classic/*.json |
navbar and footer labels |
docusaurus-plugin-content-*.json, code.json |
sidebar, blog and theme labels |
- A translated page mirrors the path of the English one (
docs/roastgate/installation.md→i18n/fr/docusaurus-plugin-content-docs/current/roastgate/installation.md). A page without translation falls back to English. - Keep the same
slugin the front matter, so/blog/roastgate-0.1.0becomes/fr/blog/roastgate-0.1.0. - Do not copy images into
i18n/: reference the English ones with the@site/prefix, for exampleorrequire('@site/blog/2026-01-10-music-sharity/home-page.png'). All locales then share a single copy. - When a translated heading is the target of a link (
./maintenance.md#back-up-the-data), keep the English anchor with## Sauvegarder les données {/* #back-up-the-data */}. The{#id}syntax breaks the build with thefuture.v4flag. - After adding labels to the config (navbar, footer, sidebar categories), run
pnpm run write-translations --locale fr(and--locale de) to add them to the JSON files.
pnpm run buildThis 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 deployNot using SSH:
GIT_USER=<Your GitHub username> pnpm run deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.