READ ME

Stockage d'images

Rédaction (mkdocs)

Pour réaliser cette doc nous avons utiliser mkdocs

Installation

sudo apt install python-pip: installer pip3
sudo apt-get install python3-setuptools: installer les setuptools de python
pip3 install mkdocs: installer mkdocs
pip3 install mkdocs-<theme> : installer un thème mkdocs

Les commandes utiles

• mkdocs new [dir-name]: Créer un nouveau projet
• mkdocs serve: Démarrer le serveur de documentation live-reloading (en local)
• mkdocs build: Builder le site
• mkdocs -h: Obtenir de l'aide

Mise en ligne (github.io)

La mise en ligne se fait grâce a la GitHub action modifiable dans le répertoire du projet (/.github/workflows/build)