README.md

BUT MMI 3ème année, GIT 2023

Ce projet collaboratif est une documentation sur l'utilisation de GIT, rédigée de manière collaborative par les étudiants de 3ème année du BUT MMI de Dijon.

Il permettra aux étudiants d'utiliser Docker, GIT, Markdown, Github...

Démarrage

Le projet utilise Mkdocs comme générateur de site web.

Plus précisément, nous utilisons squidfunk/mkdocs-material pour profiter d'un thème agréable.

Pour démarrer le serveur de développement, Docker doit tourner sur votre poste.

Vous devez ensuite lancer cette commande :

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Mise en forme : feuille de style pour les titres

La feuille de style

Commencez d'abord par créer votre feuille de style et placez la dans un dossier.

Par exemple :

docs/stylesheets/extra.css

Rendez-vous sur la documentation de Mkdocs-material :

https://squidfunk.github.io/mkdocs-material/

Footnotes

Une footnote permet fournir des informations supplémentaires ou des références dans un document, qui seront situé en pied de page. Généralement utilisé pour ajouter des définitions, des sources et explications pertinentes au contenu principal.

Pour faire une footnote il faut deux choses, une mentions de la footnote :

Footnote[^1].
Footnote avec plusieurs lignes[^2].
Footnote nommé[^nom]

Et notre note :

[^1]: texte référencé.
[^2]: On peut mettre deux espaces.
   Pour avoir une autre ligne a notre footnote.
[^nom]: Les footnotes nommés apparaissent toujours comme des nombres mais sont plus faciles a identifier lors de modifications

Footnote¹. Footnote avec plusieurs lignes². See note here³

Footnotes

1. texte référencé. ↩

2. On peut mettre deux espaces. Pour avoir une autre ligne a notre footnote. ↩

3. Les footnotes nommés apparaissent toujours comme des nombres mais sont plus faciles a identifier lors de modifications ↩