home.md

-# Recueil d'informations sur le "Gitlab Flavored Markdown" 
+** "Gitlab Flavored Markdown" **
 
 Auteur : C. Poulard, 2022
 
-## Objectif :
+## Objectif : 
 GitLab offre la possibilité de rédiger des pages en markdown pour accompagner le code. C'est une fonctionnalité intéressante, mais le format Markdown utilisé est spécifique. On parlera donc de "GitLab Flavored Markdown", qui est différent du "GitHub Flavored Markdown" et du Markdown Standard.
 
 L'objectif est de regrouper ici toutes les infos glanées en rédigeant des **readme.md** et des **wiki**, en insistant sur celles qui sont difficiles à trouver dans [**la doc de gitlab**](https://about.gitlab.com/handbook/markdown-guide).
@@ -11,12 +11,6 @@ Difficulté : les fonctions évoluent ! !
 
 Pour qu'une doc soit facile à utiliser, il vaut mieux que la **structure** soit logique, que la **mise en forme** soit agréable et mette bien en évidence les concepts importants (gras, italique...). 
 
-Comparons deux solutions : la doc en ligne (sous forme de wiki) et un PDF.
-L'avantage du **PDF** est qu'il est "stable" et **consultable hors ligne**. Les logiciels de traitement de texte permettent de construire une hiérarchie de titres formatés et de générer des tables des matières, de gérer la numérotation de tableaux et de figures et d'en générer les tables, d'insérer des notes de bas de page ou encore de gérer des liens hypertexte (notion de "signet") si on se donne la peine de les définir. Ils permettent également de travailler en mode "révision".
-L'avantage du **document en ligne**, de type wiki, est qu'il est facile à maintenir à jour, et à consulter sans téléchargement.
-Cette page contient des informations pour retrouver autant de fonctionnalités que possible d'un traitement de texte : mettre en forme, générer un sommaire et des liens hypertexte. 
-   :warning: numéroter les illustrations et générer une table n'est sans doute pas possible
-
 Les fichiers du **wiki** sont au format **markdown** spécifique à gitlab.
 On peut les modifier en ligne: gitlab fournit un éditeur simple et un éditeur plus avancé depuis 2021. Quand vous sauvegardez les modifications vous pouvez personnaliser un "commit message" : en effet, ce wiki est techniquement un dépôt (repository). Il est donc possible de **cloner ce dépôt**, de modifier les fichiers markdown en local puis de mettre à jour le wiki avec un git push.
 
@@ -42,7 +36,14 @@ NB : la doc propose deux syntaxes, dont une qui ne marche pas (avec les undersco
 > Add either the [[_TOC_]] or [TOC] tag on its own line to the Description field of any of the supported content types:     Markdown files,     Wiki pages,... 
 [lien](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents)
 
-## Utilisation du wiki en complément du repo
+## Introduction : une doc en PDF ou dans le wiki du dépôt gitlab ?
+
+L'avantage du **PDF** est qu'il est "stable" et **consultable hors ligne**. Les logiciels de traitement de texte permettent de construire une hiérarchie de titres formatés et de générer des tables des matières, de gérer la numérotation de tableaux et de figures et d'en générer les tables, d'insérer des notes de bas de page ou encore de gérer des liens hypertexte (notion de "signet") si on se donne la peine de les définir. Ils permettent également de travailler en mode "révision".
+L'avantage du **document en ligne**, de type wiki, est qu'il est facile à maintenir à jour, permet le travail à plusieurs en prenant quelques précautions, et il est consultable sans téléchargement.
+
+Cette page contient des informations pour retrouver autant de fonctionnalités que possible d'un traitement de texte : mettre en forme, générer un sommaire et des liens hypertexte. 
+   :warning: numéroter les illustrations et générer une table n'est sans doute pas possible
+
 On donnera ici :
 - quelques avantages de remplir le readme et le wiki : informations sur le code mis à disposition (contact, contexte, aide à l'installation et à l'utilisation...) **faciles à mettre à jour** !
 - quelques inconvénients par rapport à une doc classique :