Un éditeur WYSIWYG pour éditer des fichiers Markdown ?
Si ça vous intrigue, suivez le guide !
[Mise à jour] Typora n'est pas un outil libre, et seule la version bêta semble gratuite. Pour éviter tout risque d'adaptation à un logiciel ultérieurement payant, nous proposons d'utiliser un clone libre de typora: MarkText.
Typora MarkText, par amour du markdown
Cet outil s'appelle typora, et le site officiel est là: typora MarkText
Je vous présente cet outil que je vais tester pour la série d'article autour de gitlab CI/CD.
Il est disponible pour Windows, Linux, et Mac OS.
Des fonctionnalités pour profiter de la puissance du markdown
Les fonctionnalités de l'éditeur permettent de profiter de la puissance du format markdown, car il est à la fois possible de sauvegarder des fichiers directement en markdown, mais également de copier le texte au format markdown.
Un éditeur wysiwyg
Voici, par exemple, le rendu de cet article (dans sa version française)
Il suffit donc d'appliquer aux textes les formats souhaités (Titre 1-2-3, gras, italiques, etc. ) en le sélectionnant dans le menu, ou en utilisant les raccourcis habituels (CTRL+B, CTRL+I)
Sauvegarder au format MD
Il suffit de sauvegarder le fichier, et Typora vous propose deux formats d'enregistrement: .md ou .txt. MarkText ne propose que le .md.
Exporter le contenu au format MD
Typora MarkText propose une fonctionnalité très intéressante: l'export au format markdown.
Ainsi, si j'exporte le contenu de l'article (dans sa version française, toujours):
Un éditeur WYSIWYG pour éditSauvegarder au format MDer des fichiers Markdown ?
Si ça vous intrigue, suivez le guide !
# Typora, par amour du markdown
C'est outil s'appelle typora, et le site officiel est là: [typora](https://typora.io/)
Je vous présente cet outil que je vais tester pour la série d'article autour de gitlab CI/CD.
Il est disponible pour Windows, Linux, et en version beta (à l'heure d'acriture de ces lignes) pour Mac OS.
## Des fonctionnalités pour profiter de la puissance du markdown
Les fonctionnalités de l'éditeur permettent de profiter de la puissance du format markdown, car il est à la fois possible de sauvegarder des fichiers directement en markdown, mais également de copier le texte au format markdown.
### Un éditeur wysiwyg
Voici, par exemple, le rendu de cet article (dans sa version française)
Il suffit de sélectionner la partie que l'on souhaite exporter, puis utiliser l'entrée du menu ou d'appliquer le raccourci dédié: CTRL + MAJ + C (raccourci valable sus typora et sous MarkText)
La correction orthographique sur des fichiers Markdown
Cette fonctionnalité ne mérite pas d'être détaillée, je suppose.
La qualité du Markdown
Nos article sont soumis, avant build du site par Hugo, à mardownlint, un utilitaire permettant de valider la syntaxe markdown. Le présent article obtient le résultat suivant:
$ mdl content/posts/*.md --ignore-front-matter --rules ~MD013,~MD026,~MD033
content/posts/typora_fr.fr.md:13: MD009 Trailing spaces
content/posts/typora_fr.fr.md:15: MD009 Trailing spaces
content/posts/typora_fr.fr.md:21: MD009 Trailing spaces
content/posts/typora_fr.fr.md:23: MD009 Trailing spaces
content/posts/typora_fr.fr.md:27: MD009 Trailing spaces
content/posts/typora_fr.fr.md:39: MD009 Trailing spaces
content/posts/typora_fr.fr.md:45: MD009 Trailing spaces
content/posts/typora_fr.fr.md:47: MD009 Trailing spaces
content/posts/typora_fr.fr.md:50: MD009 Trailing spaces
content/posts/typora_fr.fr.md:52: MD009 Trailing spaces
content/posts/typora_fr.fr.md:58: MD009 Trailing spaces
content/posts/typora_fr.fr.md:60: MD009 Trailing spaces
content/posts/typora_fr.fr.md:64: MD009 Trailing spaces
content/posts/typora_fr.fr.md:75: MD009 Trailing spaces
content/posts/typora_fr.fr.md:81: MD009 Trailing spaces
content/posts/typora_fr.fr.md:82: MD009 Trailing spaces
content/posts/typora_fr.fr.md:84: MD009 Trailing spaces
content/posts/typora_fr.fr.md:96: MD009 Trailing spaces
content/posts/typora_fr.fr.md:100: MD009 Trailing spaces
content/posts/typora_fr.fr.md:109: MD009 Trailing spaces
content/posts/typora_fr.fr.md:35: MD012 Multiple consecutive blank lines
content/posts/typora_fr.fr.md:36: MD012 Multiple consecutive blank lines
content/posts/typora_fr.fr.md:90: MD012 Multiple consecutive blank lines
content/posts/typora_fr.fr.md:91: MD012 Multiple consecutive blank lines
content/posts/typora_fr.fr.md:105: MD012 Multiple consecutive blank lines
content/posts/typora_fr.fr.md:106: MD012 Multiple consecutive blank lines
La qualité des fichiers produits est très bonne. Seules les erreurs d'espace de fin de ligne et de multiples lignes blanches (visible depuis la version wysiwyg, donc) sont à considérer lors de la saisie.
Les usages
Les articles de site Hugo
Pour gérer nos articles, typora MarkText est très utile.
En création, il suffit de sauvegarder le fichier quelque part, et de l'ajouter directement depuis l'interface web de gitlab.
En modification, idem. Il suffit d'éditer l'article depuis gitlab, puis utiliser la fonction de copie au format MD, puis d'export au format MD.
Pour une utilisation plus poussée, il est possible de gérer le dossier d'article du site directement depuis typora, mais sans qu'il soit possible de gérer le dépôt git (à ma connaissance):
En déportant l'usage de git avec le terminal, typora MarText peut tout à fait servir à gérer les articles d'un blog utilisant les moteurs Hugo ou Jekyll.
Nos utilitaires
Nos utilitaires s’appuient tous sur le format Markdown:
- nos wikis;
- les readme de nos développements;
- notre KB;
- nos ADR
L'outil d'export au format mardkown permet d'éditer les textes sous typora MarkText, et ainsi ne plus se préoccuper de la syntaxe, tout en bénéficiant de la possibilité d'éditer directement au format markdown si nécessaire (lors d'une revue de la structure d'un article, par exemple).
Conclusion
Au départ de la série d'article sur gitlab CI/CD, je pense que je préfère encore utiliser la syntaxe MD directement, plutôt qu'un éditeur WYSIWIG.
Néanmoins, à l'usage, c'est séduisant. Il n'est pas impossible que la série d'articles qui arrive ne me fasse changer d'opinion !