evcc docs

Official documentation repository of evcc. The site is built with Astro and the Starlight docs theme.

General

• The source content of the folder templates is the templates/definition folder in the evcc repository.
• We recommend testing changes locally. The instructions below show how to run the documentation site so you can see your edits live as you make them.

Local setup

First clone the repository, then follow with the steps below.

Requirement: nodejs (version ≥ 26) and npm (comes with nodejs).

Installation

npm ci

Local development

npm run dev

This starts the Astro dev server with hot reload. All locales are served from the same instance:

• English: http://localhost:4321/en
• German: http://localhost:4321/de
• Dutch, French, Danish, Italian, Czech: http://localhost:4321/nl, /fr, /da, /it, /cs

Build

npm run build

This builds the static site into dist/ and runs the legacy-redirect generator. The output can be served by any static host.

Contributing

Code formatting

Before submitting a PR, run npm run format to ensure consistent formatting. The CI pipeline checks formatting and will fail if files are not formatted.

VS Code users: the repository includes recommended settings to format files automatically on save.

Content changes

English (src/content/docs/en/) is the only hand-written locale. All other locales are translated automatically from English and stamped with translatedFrom. Don't edit them by hand: change the English source, then run /translate all to update every locale at once (rules in scripts/i18n/RULES.md). If writing English is hard for you, open the PR anyway and say so; maintainers help with the wording.