Pour commencer¶
Bienvenue sur npi_news ! Ce guide vous aidera à démarrer.
Prérequis¶
- Python 3.8 ou supérieur
- pip (installateur de paquets Python)
- Git
- Java (pour le rendu des diagrammes PlantUML)
Installation¶
-
Cloner le dépôt (si ce n'est pas déjà fait) :
git clone https://github.com/ovesorg/npi_news.git cd npi_news -
Installer les dépendances Python :
pip install -r requirements.txt
Démarrage rapide¶
Démarrer le serveur de développement¶
mkdocs serve
Ouvrez votre navigateur sur http://127.0.0.1:8000
Construire le site¶
mkdocs build
Le site statique sera généré dans le répertoire site/.
Étapes suivantes¶
- 📝 Modifier le contenu dans le dossier docs/
- 📊 Ajouter des diagrammes PlantUML dans docs/diagrams/plantuml/
- 🎨 Personnaliser les styles dans docs/stylesheets/extra.css
- ⚙️ Configurer la navigation dans mkdocs.yml
Travailler avec les diagrammes¶
Pour rendre les diagrammes PlantUML :
python scripts/render_plantuml.py
Placez les fichiers .puml dans docs/diagrams/plantuml/ et ils seront rendus en PNG dans docs/diagrams/images/.