From 496425894179a814a48aa676cfe21bce361e2725 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Sun, 3 May 2020 23:42:57 +0200 Subject: [PATCH] Replace README.rst with README.md --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 51 --------------------------------------------------- 2 files changed, 54 insertions(+), 51 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..62ff417 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +data.coop-website +================= + +[![Build Status](https://drone.data.coop/api/badges/data.coop/website/status.svg)](https://drone.data.coop/data.coop/website) + +This is a [Hugo](https://gohugo.io/) project. + +Running locally +--------------- + +Go to [Hugo Github release](https://github.com/gohugoio/hugo/releases) +and fetch the latest package for **hugo\_extended** for your system. + +We want to align with the latest version always. If it doesn't work, +file an issue! + +Example recipe + +``` {.sourceCode .bash} +# Fetch .deb from Github +wget https://github.com/gohugoio/hugo/releases/download/v0.69.2/hugo_extended_0.69.2_Linux-64bit.deb -O hugo_extended.deb + +# Install package +sudo dpkg -i hugo_extended.deb + +# Clone repo +git clone https://git.data.coop/data.coop/website.git data.coop-website + +# Go to website +cd data.coop-website + +# Run development server +hugo server +``` + +Deploying the site +------------------ + +Simply pushing to `master` in our main repo at + will trigger a +build-and-deploy of the website. + +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. +2. Each content article and news text has a language version such + `content/.en.md` +3. The `config.yaml` contains settings specific to each language, such + as navigation. + diff --git a/README.rst b/README.rst deleted file mode 100644 index b984fce..0000000 --- a/README.rst +++ /dev/null @@ -1,51 +0,0 @@ -data.coop-website -================= - -.. image:: https://drone.data.coop/api/badges/data.coop/website/status.svg - :alt: Build Status - :target: https://drone.data.coop/data.coop/website - -This is a `Hugo `__ project. - -Running locally ---------------- - -Go to `Hugo Github release `__ and fetch the latest package for **hugo_extended** for your system. - -We want to align with the latest version always. If it doesn't work, file an issue! - -Example recipe - -.. code-block:: bash - - # Fetch .deb from Github - wget https://github.com/gohugoio/hugo/releases/download/v0.69.2/hugo_extended_0.69.2_Linux-64bit.deb -O hugo_extended.deb - - # Install package - sudo dpkg -i hugo_extended.deb - - # Clone repo - git clone https://git.data.coop/data.coop/website.git data.coop-website - - # Go to website - cd data.coop-website - - # Run development server - hugo server - - -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. - - -Multilingual notes ------------------- - -Our website is made multi-lingual using the following 3 structures: - -#. 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. -