https://github.com/geotribu/site-contribuer
Sources du site contenant les guides de contribution à Geotribu.
https://github.com/geotribu/site-contribuer
contribution geotribu mkdocs wiki
Last synced: 2 months ago
JSON representation
Sources du site contenant les guides de contribution à Geotribu.
- Host: GitHub
- URL: https://github.com/geotribu/site-contribuer
- Owner: geotribu
- License: mit
- Created: 2023-01-02T11:58:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T11:40:11.000Z (3 months ago)
- Last Synced: 2025-02-14T12:36:16.422Z (3 months ago)
- Topics: contribution, geotribu, mkdocs, wiki
- Language: Python
- Homepage: https://contribuer.geotribu.fr/
- Size: 2.8 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Site web dédié à la contribution à Geotribu
[](https://github.com/geotribu/site-contribuer/actions/workflows/deploy.yml)
[](https://results.pre-commit.ci/latest/github/geotribu/site-contribuer/main)
----
## 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) :
```bash
python -m pip install -U pip
python -m pip install -U setuptools wheel
```
### Version gratuite
```bash
python -m pip install -U -r requirements-free.txt
```
#### Version Insiders
Pour utiliser la [version Insiders du thème Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/insiders/), il faut disposer du *token* lié au compte GitHub de Geotribu :
```bash
export GH_TOKEN_MATERIAL_INSIDERS=************
python -m pip install -U -r requirements-insiders.txt
```
### Générer le site
Version complète :
```bash
mkdocs build
```
Version complète gratuite :
```bash
mkdocs build -f mkdocs-free.yml --dirtyreload
```
Version minimale (seulement certains plugins) :
```bash
mkdocs build -f mkdocs-minimal.yml
```
### Servir le site en local
Version complète :
```bash
mkdocs serve --dirtyreload
```
Version complète gratuite :
```bash
mkdocs serve -f mkdocs-free.yml --dirtyreload
```
Version minimale (seulement certains plugins) :
```bash
mkdocs serve --dirtyreload -f mkdocs-minimal.yml
```
Le site est accessible en local à l'adresse suivante : .
Quand un contenu est modifié, le site est automatiquement rechargé.
----
## Soutenir
Afin de pérenniser le site, nous avons ouvert un compte sur Liberapay : .
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 )
- GeoRezo (pour le CDN)
- financer les suffixes du nom de domaine (geotribu.fr/.net/.org)