Skip to content

Latest commit

 

History

History
120 lines (77 loc) · 4.13 KB

README.md

File metadata and controls

120 lines (77 loc) · 4.13 KB

Site web de Geotribu

🚀 Déploiement pre-commit.ci status Pull Request Checker 🛃 🎳 Markdown Linter 🎳 Vérification des liens 🤖 Réponse automatique à un ticket de proposition de contenu

Ouvrir dans l'éditeur en ligne

Built with Material for MkDocs

Sources et contenus du site de Geotribu, accessible via les URLs suivantes :


Démarrage rapide

Important

Les instructions données ici se veulent succinctes et ne sont donc pas complètes. Pour un vrai guide de contribution en local, consulter le guide détaillé : Installation et configuration de l'environnement de travail pour l'édition locale.

Prérequis

  • Python >= 3.9

Recommandés

  • Visual Studio Code

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

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é.


Contribuer

Pour la procédure détaillée, consulter le site dédié.

Soutenir

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

Liberapay receiving Liberapay patrons

L'objectif de ce financement est de :

  • financer les outils open-source que l'on utilise pour le site :
  • financer les suffixes du nom de domaine (geotribu.fr/.net/.org)