Archive du forum du MOOC Recherche Reproductible Session 2

Suppléments autour du markdown

bclmary

Bonjour,

Je propose ici quelques retours personnels autour du Markdown.

Au départ, j’ai hésité entre le Markdown et le ReStructuredText du monde python. La norme du RST est clairement mieux définie et plus complète. Mais à l’usage, le markdown se révèle plus simple. On peut faire moins de choses avec, mais ces choses couvrent 90% de l’usage courant.

bclmary

Pour l’édition, je recommande remarkable (développé par GitHub, et cité dans le cours), éditeur spécialié, ou l’éditeur Visual Studio Code de Microsoft (qui pour une fois proposent un logiciel en licence libre !). VSCode devient mon éditeur de référence, et les plugins autour du mardown sont nombreux (diffrentes normes, maths, inclusion d’autre langages, etc…).

bclmary

En plus du makdown, j’ai aussi découverts des langages pour réaliser des figures / schéma, basés sur une syntaxe simple.

J’ai particulièrement retenu le graphviz, le plantUML, et le mermaid

Bien que le mermaid ai le rendu le plus esthétique, je recommande le plantUML, car il intègre graphviz (pour les graphes) et est reconnu par défaut par gitHub et GitLab.

Un exemple de graphe dans un extrait de code markdown taggé plantuml

digraph G {
A -> B
B -> C
B -> A
}
PierreBM

Pour ma part, j’utilise de plus en plus Atom.io, un éditeur de texte plesbiscité par les geeks qui possède un mode preview pour le markdown.

khinsen

En fait, pour utiliser reStructuredText de façon efficace, il faut s’en servir très régulièrement. Sinon on oublie toutes les subtilités du syntaxe et on passe son temps à relire la documentation. Même dans la communauté Python, haut-lieu de reStructuredText, il y a de plus en plus de gens qui préfèrent Markdown.

nkarasiak

Je confirme, Atom.io est super avec tout un tas de plugin bien pratique (notamment pour le markdown, dont un convertisseur markdown>pdf)