https://github.com/rok4/rok4.github.io
Documentation principale du projet
https://github.com/rok4/rok4.github.io
documentation
Last synced: 3 months ago
JSON representation
Documentation principale du projet
- Host: GitHub
- URL: https://github.com/rok4/rok4.github.io
- Owner: rok4
- Created: 2022-07-13T12:58:34.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T14:27:33.000Z (over 1 year ago)
- Last Synced: 2025-03-24T15:30:34.793Z (over 1 year ago)
- Topics: documentation
- Homepage: https://rok4.github.io/
- Size: 3.28 MB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation officielle du projet ROK4
Sources du site de documentation et du générateur de site statique associé (Mkdocs).
## Démarrage rapide
### Guide de rédaction
[Cette page](https://squidfunk.github.io/mkdocs-material/reference/formatting/) donne des indications sur les capacités et spécificités de l'implémentation de la syntaxe Markdown.
### Prérequis
- Python >= 3.9
### Installation
Après avoir cloné ou téléchargé le dépôt, installer les prérequis :
```bash
python -m pip install -U -r requirements.txt
```
### Générer le site
```bash
mkdocs build
```
Avec une tolérance 0 aux erreurs :
```bash
mkdocs build --strict
```
### Servir le site en local
```bash
mkdocs serve
```
Avec rechargement à chaud sélectif :
```bash
mkdocs serve --dirtyreload
```
Le site est accessible en local à l'adresse suivante : .
Quand un contenu est modifié, le site est automatiquement rechargé.