forked from ScoDoc/DocScoDoc
1.2 KiB
1.2 KiB
Documentation de ScoDoc
Documentation (Web) de ScoDoc, en MkDocs.
Version en ligne sur scodoc.org.
Historique
L'ancienne documentation de ScoDoc7, hébergée au LIPN sur une plate-forme Trac, a été traduite en Markdown en septembre 2020 et passée sous git.
Le site est depuis hébergé sur [https://scodoc.org].
Installation mkdocs
Il est recommandé de créer un virtualenv:
python3.11 -m venv venv
source venv/bin/activate
(n'importe quelle version de python récente fera l'affaire).
Puis installer les composants suivants dans ce virtualenv:
pip install mkdocs
pip install pymdown-extensions
pip install mkdocs-material
pip install mkdocs-plugin-inline-svg
Génération de la doc
Pour générer le site:
mkdocs build
Pour lancer un serveur local permettant d'afficher la doc, avec rafraichissement automatique dès qu'un fichier source est modifié:
mkdocs serve
Pour le reste voir la documentation de MkDocs.
WIP
- reprendre la page BUT.md