Commit d05e28f8 authored by Daniel Brötzmann's avatar Daniel Brötzmann
Browse files

Update README.md

parent 91c36e3b
# Website repository for gajim.org
This is the new [Hugo](https://gohugo.io)-powered website for gajim.org.
This is the [Hugo](https://gohugo.io)-powered website for [gajim.org](https://gajim.org).
A preview of this site can be viewed here: https://devel.gajim.org/
A preview of this site can be viewed at [devel.gajim.org](https://devel.gajim.org)
---
......@@ -23,30 +23,30 @@ A preview of this site can be viewed here: https://devel.gajim.org/
This website can be viewd and modified on your local machine.
To work locally, follow the steps below:
1. Fork, clone or download website-dev
2. [Install](https://gohugo.io/overview/installing/) Hugo
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 (see [translation](#translation)).
[translation service](#translation).
Read more at Hugo's [documentation](https://gohugo.io/overview/introduction/).
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 can be accessed under `localhost:1313`.
the site will be accessible at `localhost:1313`.
The theme used for gajim.org is adapted from http://themes.gohugo.io/beautifulhugo/.
The theme used for gajim.org is adapted from [Beautiful Hugo](http://themes.gohugo.io/beautifulhugo).
## Translation
* Content translation 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 set 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).
* 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).
......@@ -55,5 +55,4 @@ Read more about [how the markdown translation process works](https://dev.gajim.o
Static pages of gajim.org are built by [GitLab CI](https://about.gitlab.com/gitlab-ci/), following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml).
Learn more about [GitLab Pages](https://pages.gitlab.io) and the [official
documentation](https://docs.gitlab.com/ce/user/project/pages/).
Learn more about [GitLab Pages](https://pages.gitlab.io) and the [official documentation](https://docs.gitlab.com/ce/user/project/pages/).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment