Aller au contenu

Markdown mon amour

Markdown Kesako

C'est un langage de balisage léger de document conçu par John Gruber avec Aaron Swartz

Ce langage connait aujourd'hui un grand succés je ne vais pas faire une Nieme page décrivant la syntaxe.

Je vais juste donner quelques liens utiles sur le sujet et produire un tableau montrant les difféerences de syntaxe entre 3 ou 4 implémentations.

Documents de références sur Markdown

La syntaxe

Dans un document du 17 décembre 2004 John Gruber en présente

Mes références

  • La page de documentation utilisée pour la premiére version de ce site mdwiki...
  • La page de MkDocs générateur de site utilisé pour la version actuele.

    • La page de documentation pour le thème utilisé.
    • La page de documentation pour le plugin d'encryption
  • La page Welcome de l'éditeur en Stackedit...

  • La page de l'éditeur Haroopad.
  • Le très documenté article sur markdown-pandoc de Jean-Daniel Bonjour
    • Il a aussi écrit un cours sur python.
    • et maintient l'annuaire des logiciel libre de l'EPFL.

Une comparaison des supports

Le site markdownguide propose de parcourir la syntaxe et ses extensions mais surtout il référence un ensemble d'outil utilisant la syntaxe Markdown.

Le site css-tricks a publié un article de Ray Villalobos comparant différentes variantes de Markdown.

J'utilise régulièrement plusieurs outils ayant un support de Markdown

  1. MkDocs Python-Mardown avec plusieurs extension
  2. github proche de Discourse
  3. slack
  4. pandoc
  5. pleroma
  6. discourse

Voici un tableau comparatif du support de MarkDown pour MkDocs, pleroma et Discourse support commonmark.

Element Mkdocs Discource Pleroma
Headings Yes Yes No
Paragraphs Yes Yes Yes
Line Breaks Yes Yes Yes
Bold Yes Yes Yes
Italic Yes Yes Yes
Strikethrough No Yes Yes
Blockquotes Yes Yes Yes -
Ordered Lists Yes - Yes Yes
U Nordered Lists Yes - Yes Yes
Code Yes Yes Yes
Horizontal Rules Yes Yes No
Links Yes Yes Yes
Images Yes Yes Yes
Tables Yes Yes No
Fenced Code Blocks Yes Yes No
Syntax Highlighting Yes Yes No
Foot Notes No No No
Heading IDs No No No
Definition Lists No No No
Strikethrough No No Yes
Task Lists No No No
Emoji (copy and paste) UnkNown UnkNown UnkNown
Emoji (shortcodes) :tent: Unknown No
Automatic URL Linking YES Yes Yes
Disabling Automatic URL Linking YES Yes No
HTML Yes Yes Yes

Un outil de comparaison en ligne(https://johnmacfarlane.net/babelmark2/?normalize=1&text=%0A~~~barr%C3%A9~~~) permet de tester les prises en compte par les parsers.