Markdown
Table des matières
Figure 1 : MarkDown
1 Présentation
le markdown est un langage de formatage de texte bâti sur un système de balises très léger ('markup language' signifie 'langage à balise', d'où le nom 'markdown' pour un langage à balise très léger). Il est réellement très simple et on peut l'utiliser de façon pertinente après une quinzaines de minutes. Ses balises sont légères, ce qui signifie que l'on peut lire le texte sans être gêné par les balises si on ne dispose pas de lecteur markdown. Il possède les limites liées à sa simplicité, mais il est suffisant pour une communication simple.
Il est actuellement utilisé (entre autres) :
- fichiers 'readme'
- email élaborés
- fichiers de présentation et documentation sur les serveurs git (gitlab, github,…)
- documentation dans doxygen
- Jupyter Notebooks
Il possède différentes saveurs (flavours), ce qui signifie des variations légères de syntaxe ou de possibilités. La saveur actuellement la plus utilisée est celle utilisée par github, celle de kaggle possède quelques variations… mais ce ne sont que des nuances.
2 Du markdown vers \(\LaTeX\), html, odt…
2.1 Navigateur internet
Afin de pouvoir composer et envoyer des mails en markdown, vous pouvez installer un greffon, disponible sur https://markdown-here.com/get.html. Ainsi vous pourrez installer la prise en charge du markdown aussi bien dans vos fenêtres de composition de mail navigateur que dans des gestionnaires de mail plus élaborés type thunderbird. Il est à noter que le récipiendaire de vos mail n'a pas besoin de posséder le greffon pour pouvoir visualiser le mail (sinon l'outil serait peu utile !), il lui suffit d'accepter la lecture des mails au format html.
2.2 linux
L'outil de référence est pandoc, il permet de transformer un document d'un certain type en un document d'un autre type. On ne peut pas exiger des merveilles de ce genre d'outil, la conception d'un document écrit en \(\LaTeX\) n'est pas celle d'un document écrit en markdown, et la traduction automatique d'un format comme \(\LaTeX\) à du markdown entraînera des pertes plus ou moins conséquentes…
Cependant cet outil pourra vous servir de couteau suisse de la traduction de documents formatés, par exemple passer vos documents au format org-mode (un des éléments phares d'emacs).
La page de -pandoc- qui est liée précédemment vous indique ce que peut faire pandoc, selon le sens des flèches, il est possible de traduire depuis ou vers un langage donné. N'hésitez pas à jeter un coup d'oeil aux différents formats de documents proposés, ils devraient pour la grande majorité faire partie de votre culture informatique (il n'est pas demandé de savoir les utiliser, mais de savoir qu'ils existent, et avoir une idée de leur utilisation).
Il existe des éditeurs qui permettent de lire et écrire du markdown, tels que atom ou remarkable qui peuvent avoir vos faveurs, sans oublier emacs bien sûr…
3 La pratique
- Suivre ces lessons. Attention, ce markdown ne donne qu'une saveur, et ne
propose que les bases. Vous devrez expérimenter pour au moins :
- Savoir présenter un document hiérarchisé (titres, énumérations, listes)
- Savoir créer des tables
- Insérer du code dans différents langages (c, c++, …)
- Réaliser des boîtes à cocher
- Insérer des formules, là c'est plus sport car la saveur github ne reconnaît pas de mode mathématiques en natif (alors que la saveur kaggle l'accepte relativement bien). Pour contourner ce problème, une méthode consiste à créer une image du rendu de la formule mathématique, muis de l'insérer dans le texte. Pour créer cette image, on peut par exemple utiliser cet éditeur.
- insérer des images
- utiliser un aide mémoire (voire l'imprimer) tel que ceci ou cela.
- parcourir le document markdown-pandoc et savoir s'y référer rapidement lorsque vous en éprouverez le besoin.
4 La collaboration
Il est possible d'utiliser un éditeur markdown collaboratif, par exemple : https://hackmd.io/ qui est gratuit pour un usage personnel. Cela peut permettre de prendre des notes de cours en commun, avec un rendu acceptable et sans la lourdeur d'autres outils. L'outil cité ci-dessus dispose des fonctions permettant d'intégrer quelques émoticônes et surtout des formules mathématiques au format \(\LaTeX\).