diff --git a/README.rst b/README.rst index 49a24064..b984fce9 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,5 @@ -# data.coop-website +data.coop-website +================= .. image:: https://drone.data.coop/api/badges/data.coop/website/status.svg :alt: Build Status @@ -6,7 +7,8 @@ This is a `Hugo `__ project. -## Running locally +Running locally +--------------- Go to `Hugo Github release `__ and fetch the latest package for **hugo_extended** for your system. @@ -32,16 +34,18 @@ Example recipe hugo server -## Deploying the site +Deploying the site +------------------ -Simply pushing to `master` in our main repo at https://git.data.coop/data.coop/website/ will trigger a build-and-deploy of the website. +Simply pushing to ``master`` in our main repo at https://git.data.coop/data.coop/website/ will trigger a build-and-deploy of the website. -## Multilingual notes +Multilingual notes +------------------ Our website is made multi-lingual using the following 3 structures: -1. The folder ``i18n/`` contains translations of strings used in the theme. -1. Each content article and news text has a language version such ``content/.en.md`` -1. The ``config.yaml`` contains settings specific to each language, such as navigation. +#. The folder ``i18n/`` contains translations of strings used in the theme. +#. Each content article and news text has a language version such ``content/.en.md`` +#. The ``config.yaml`` contains settings specific to each language, such as navigation.