README.md

# Website repository for gajim.org

This is the [Hugo](https://gohugo.io)-powered website for [gajim.org](https://gajim.org).

---

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Website repository for gajim.org](#website-repository-for-gajimorg)
  - [Building locally](#building-locally)
    - [Preview your site](#preview-your-site)
  - [Translation](#translation)
  - [GitLab CI](#gitlab-ci)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Building locally

This website can be viewed and modified on your local machine.

To work locally, follow the steps below:

1. Fork, clone or download the `website` repository
2. [Install Hugo](https://gohugo.io/overview/installing/)
3. Preview Gajim's website locally: `hugo server`
4. Add or modify content

If you want to modify files in the `content` directory, please change files in
the `en` directory only. Content for other languages will be generated from our
[translation service](#translation).

Read more about Hugo and how it works in the [documentation](https://gohugo.io/overview/introduction/).

### Preview your site

If you clone or download this project to your local computer and run `hugo server`,
the site will be accessible at `localhost:1313`.

The theme used for gajim.org is adapted from [Beautiful Hugo](http://themes.gohugo.io/beautifulhugo).

## Translation

* Content translations for gajim.org are managed by our translation service at [translate.gajim.org](https://translate.gajim.org/). This covers most of our content, including pages and posts.
* Menus are translated manually, using config files for each language (for [example](https://dev.gajim.org/gajim/website/blob/master/config/_default/menus.fr.toml) `menus.fr.toml` for French.
* The website's title and other locale specific configuration (e.g. date formatting) are configured in `languages.toml`.
* Additionally, generic strings used by our theme (e.g. page navigation, read more) are translated manually as well, using a separate `yaml` file for each language (for [example](https://dev.gajim.org/gajim/website/blob/master/themes/beautifulhugo/i18n/de.yaml) `de.yaml` for German).

Read more about [how the markdown translation process works](https://dev.gajim.org/gajim/website/blob/master/tools/translation/README.md).