README.md

Site web dédié à la contribution à Geotribu

---

Démarrage rapide

Prérequis

• Python >= 3.10

Recommandés

• NodeJS LTS (pour l'index)
• Visual Studio Code (configuration intégrée)

Installation

Après avoir cloné ou téléchargé le dépôt, installer les prérequis (de préférence dans un environnement virtuel) :

python -m pip install -U pip
python -m pip install -U setuptools wheel

Version gratuite

python -m pip install -U -r requirements-free.txt

Version Insiders

Pour utiliser la version Insiders du thème Material for Mkdocs, il faut disposer du token lié au compte GitHub de Geotribu :

export GH_TOKEN_MATERIAL_INSIDERS=************
python -m pip install -U -r requirements-insiders.txt

Générer le site

Version complète :

mkdocs build

Version complète gratuite :

mkdocs build -f mkdocs-free.yml --dirtyreload

Version minimale (seulement certains plugins) :

mkdocs build -f mkdocs-minimal.yml

Servir le site en local

Version complète :

mkdocs serve --dirtyreload

Version complète gratuite :

mkdocs serve -f mkdocs-free.yml --dirtyreload

Version minimale (seulement certains plugins) :

mkdocs serve --dirtyreload -f mkdocs-minimal.yml

Le site est accessible en local à l'adresse suivante : http://localhost:8000/.
Quand un contenu est modifié, le site est automatiquement rechargé.

---

Soutenir

Afin de pérenniser le site, nous avons ouvert un compte sur Liberapay : https://liberapay.com/Geotribu/.

L'objectif de ce financement est de :

• financer les outils open-source que l'on utilise pour le site :
  • Material for MkDocs (voir la page sponsor https://github.com/sponsors/squidfunk)
  • GeoRezo (pour le CDN)
• financer les suffixes du nom de domaine (geotribu.fr/.net/.org)