|
|
** "Gitlab Flavored Markdown" **
|
|
|
**"Gitlab Flavored Markdown"**
|
|
|
|
|
|
Auteur : C. Poulard, 2022
|
|
|
|
|
|
## 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).
|
|
|
|
|
|
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...).
|
|
|
L'objectif de ce wiki est de regrouper 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).
|
|
|
|
|
|
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.
|
... | ... | @@ -17,25 +13,22 @@ On peut les modifier en ligne: gitlab fournit un éditeur simple et un éditeur |
|
|
Une autre façon de mettre en ligne de la doc est d'utiliser le module **sphinx**, qui permet également d'extraire la description des classes si on a utilisé un format standard pour les décrire dans le code (docstring + description des paramètres)
|
|
|
|
|
|
|
|
|
## Structure de ces pages
|
|
|
Ces pages sont actuellement "en construction", dans un premier temps toutes les infos sont placées dans une page, en attendant une structuration en plusieurs pages, qui est de toutes façons indispensable pour "jouer" avec les liens.
|
|
|
|
|
|
## Sommaire (Table of Content)
|
|
|
{:.no_toc}
|
|
|
**Sommaire (Table of Content)**
|
|
|
|
|
|
**Sommaire inséré ici**, cela fait partie des fonctions à présenter !
|
|
|
Ce sommaire contient tous les **headers**, avec leur hiérarchie. Si on insère un sommaire, il ne faut donc utiliser les headers que comme titre de sections, et pas pour mettre du texte en grand pour une autre raison (ce que j'avais fait avec l'équation par exemple).
|
|
|
Le sommaire fait partie des fonctions à présenter !
|
|
|
Il contient tous les **headers**, avec leur hiérarchie. Si on insère un sommaire, il ne faut donc utiliser les headers que comme titre de sections, et pas pour mettre du texte en grand pour une autre raison (ce que j'avais fait avec l'équation par exemple).
|
|
|
Syntaxe, avec des backticks : `` `[TOC]` ``
|
|
|
`[TOC]`
|
|
|
|
|
|
Ce qui ne marche pas (encore) : soustraire un header de la table `{:.no_toc}`
|
|
|
> - TOC
|
|
|
>{:toc}
|
|
|
|
|
|
NB : la doc propose deux syntaxes, dont une qui ne marche pas (avec les underscores) `[[_TOC_]]` et indique qu'il faut ajouter ce tag à un champ "Description' ???
|
|
|
> 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)
|
|
|
|
|
|
##### Header que je voudrais soustraire de la table
|
|
|
{:.no_toc}
|
|
|
|
|
|
## 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".
|
... | ... | @@ -235,6 +228,8 @@ Pour montrer du code avec un back-tick il faut l'encadrer de backticks multiples |
|
|
<details><summary>pour voir la syntaxe cliquez ici</summary>
|
|
|
|
|
|
voilà un back-tick : ` par contre le code entre balises sera mis en forme : <kbd>espace</kbd>.
|
|
|
<details><summary>et on peut emboîter les collapsible sections</summary>
|
|
|
</details>
|
|
|
</details>
|
|
|
|
|
|
|
... | ... | @@ -441,15 +436,14 @@ La difficulté sera de construire un PDF cohérent à partir de différents fich |
|
|
* convertisseur en ligne : [Markdown2PDF](http://markdown2pdf.com/)
|
|
|
|
|
|
## Réfs
|
|
|
[la référence ?](https://docs.gitlab.com/ee/user/markdown.html)
|
|
|
|
|
|
[un guide](https://about.gitlab.com/handbook/markdown-guide/)
|
|
|
|
|
|
[exemples complet EN MARKDOWN](https://gist.github.com/rayantony/d10709d08089f05e089099110a48d7f1#file-gitlab-md)
|
|
|
|
|
|
[antisèche, plus limité](https://gitlab.com/xipas/gitlab-markdown-cheatsheet)
|
|
|
|
|
|
[la référence ?](https://docs.gitlab.com/ee/user/markdown.html)
|
|
|
|
|
|
[un guide](https://about.gitlab.com/handbook/markdown-guide/)
|
|
|
|
|
|
[les spécifications](https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/)
|
|
|
|
|
|
|