This website is built using Docusaurus 2, a static website generator.
It is being developed and translated by:
- Dominik Peters who is the main developer and did the translation to German.
- Piotr Skowron who contributed to the content and did the translation to Polish.
- Simon Rey who is translating to French.
- Davide Grossi and Maaike Los who are translating to Dutch.
To develop, you will need to install Node.js, for example using brew install node on macOS or using sudo apt install nodejs npm on Ubuntu.
For local development, go to the website directory and run:
npm install
npm run startThis will start a local development server. The website can then be viewed at http://localhost:3000/. Changes to the source files are immediately reflected in the browser.
npm run buildThis command generates static content into the build directory. This can then be served using any static contents hosting service.
To start the development server for a specific language, run:
npm run start -- --locale dereplacing de with the language code of the language you want to work on ('fr', 'pl').
The files to be translated are in the directory i18n. You need to translate the messages in the file code.json. Note that curly braces indicate variables that will be filled in at runtime. Do not translate these. For example, in (contributes {amount}), only translate contributes.
The main text is contained in files in the folder docusaurus-plugin-content-docs/current.
- When editing the Markdown files, be careful with the HTML-like tags (which are React components). A common error is to not close a tag. React requires, for example,
<img/>. - Do not change filenames.
- Do not translate anchors like
{#example}. - For monetary examples, use the format
<Currency>10</Currency>. - Some boxes begin with a line
:::tip Example. The wordtipis a keyword specifying the type of box (its symbol and color). The second word is a customized headline, which should be translated.