allan/website
1
0
Fork 0
forked from data.coop/website
Code Issues Pull requests Releases Wiki Activity

Replace README.rst with README.md

Browse source
This commit is contained in:
Benjamin Bach 2020-05-03 23:42:57 +02:00
parent ac817abfed
commit 4964258941
Signed by untrusted user: benjaoming
GPG key ID: 7D49441634585664
2 changed files with 54 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md Normal file
View file

@ -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
<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:
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/<slug>.en.md`
3. The `config.yaml` contains settings specific to each language, such
as navigation.

51
README.rst
View file

@ -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 <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
.. 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/<slug>.en.md``
#. The ``config.yaml`` contains settings specific to each language, such as navigation.