Translate the web site to your native language

Translations: Fran├žais, Deutsch

The web site of Sozi is a static site generated with Pelican. It does not provide an online editor where you could edit, preview and publish your contributions.

The source files of the site are text files using the Markdown syntax. These files are hosted in the repository Sozi-website at GitHub, in the content/ folder. The content/pages/ folder contains the documentation of Sozi. It is divided into language subfolders (en for English, fr for French, etc) containing Markdown files.

To start translating, we recommend following these steps:

  1. Fork the repository.
  2. Add a subfolder for your language in content/pages/, if it does not already exist.
  3. If you want to translate a page, find the original English version in the en folder and create a new file with the same name in your language folder.
  4. Edit the new file.
  5. Optionally, you can use Pelican to generate your own copy of the site and preview your modifications.
  6. When you are satisfied with the result, commit and push your changes to your GitHub repository and send a pull request to the official Sozi repository.

The header of a translated Markdown file should contain the following fields: