User documentation for the Website System of the GREENS

End user documentation for the Website System of the GREENS. The documentation is published at docs.gruene.ch. It refers to Websites built with the Les Verts Theme.

The documentation is built with docusaurus.

How to contribute

The documentation is located in the docs folder. Docusaurus lives in website. See it's README for more information.

Installation

• Install docker and the compose plugin.
• Add node modules with docker compose --profile dev run --rm docusaurus yarn.
• Create a .env file with the content from LastPass. See also .env.example.

The Crowdin configuration maps only the enabled de and fr languages; older mappings contain language codes rejected by the current Crowdin CLI.

Run locally

• Synchronize localization with Crowdin: docker compose --profile translate up crowdin
• Start the development server with docker compose --profile dev up.

If Docker reports orphaned one-off Docusaurus containers, remove them with docker compose --profile dev down --remove-orphans before starting again.

Build & Deploy

To build and deploy automatically in one shot, run ./deploy.sh.

To build only locally, run

# synchronize localization with Crowdin
docker compose --profile build up crowdin

# build static files
docker compose --profile build run docusaurus yarn build

# generate pdfs
docker compose --profile build run pandoc

Todo

• Automate deployment with GitHub Actions.