Utiliser le markdown pour gagner en productivité
Cela fait quelques semaines que j’ai décidé d’adopter le markdown quotidiennement. Je m’en sers notamment pour prendre des notes et rédiger les contenus de mon site perso. Je dois avouer qu’avec les bons outils, c’est un vrai gain de temps.
Le markdown, c’est quoi ?
Le markdown est un langage de balisage de texte pour faire de la mise en forme simplement. Il permet de sauvegarder dans un fichier de textes simple (non binaire contrairement à un document Word). Cela permet de faire de la mise en forme simple comme notamment : des titres, du gras ou des images.
Quelques avantages
A la différence du HTML, il est très simple à apprendre et le document reste lisible sans forcément avoir besoin d’un logiciel particulier. Sa syntaxe le rend lisible même si le fichier est ouvert avec un éditeur de texte des plus basique.
De plus, sa syntaxe permet de conserver en permanance les mains sur le clavier sans jamais avoir besoin d’utiliser sa souris. Cela est un réel gain de temps. Des outils permetteront ensuite d’afficher un rendu visuel et même d'exporter le document en PDF ou Word.
Un autre avantage non négligeable, est la légèreté des fichiers. En effet, comme expliqué plus haut, il ne s’agit pas de fichiers binaires mais seulement de fichiers de textes. Si le balisage permet de définir le type de mise en forme (titre 1, titre 2, titre 3, gras…), les styles appliqués ne sont pas sauvegardés dans le le documents mais géré dans le logiciel de rendu ou d’export. Cela allège grandement la taille du fichier puisqu’aucun style n’y est sauvegardé.
Enfin, les documents sont de simples fichiers textes que n’importe quel ordinateur ou smartphone sait ouvrir avec des logiciels natifs. Si pour avoir une jolie mise en forme il faudra utiliser un logiciel de markdown, un simple éditeur de texte permet d’accéder au contenu. Cela rend ces documents accessibles est intemporels. Il est non seulement possible de les lire depuis un simple terminal de commandes mais en plus, ils ne dépendent pas d’un logiciel ou d’une version de logiciel. Il sera alors possible d’y accèder dans 30 ans sans soucis de compatibilité.
Exemple de syntaxe
Voici quelques exemple de syntaxe :
# Ceci est mon titre 1
## Voici un sous titre
Ceci est un texte avec **du gras** ou encore de *l'italic*.
- Elément de liste 1
- Elément de liste 2
Enfin voici un [lien cliquable](https://fabienmotta.com)
Vous pourrez retrouver une liste complète des possibilités sur cette article
Cas d’utilisation
Au départ, cette syntaxe a été créé pour pouvoir facilement rédiger des documentations techniques. Elle est notamment utilisée sur GitHub sur lequel chaque paquet contient un README.md. Le markdown peut être utilisé dans beaucoup d’autres cas. Voici quelques exemples d’utilisation que j’en ai fait :
Prise de notes
Dans mon précédent article sur 3 méthodes pour un workflow efficace j’évoquais mon organisation de dossier PARA. Chacun des dossiers des projets de mes client contient un dossier /notes/ dans lequel je consigne les notes des différents échanges que nous avons eu. Dans ce cas, utiliser le markdown me permet une prise de notes rapide et efficace. De plus, le logiciel que j’utilise me permet de facilement l’exporter en PDF si besoin.
Rédaction d’article
Rédiger des articles de blog avec un editeur de markdown est un vrai gain de temps. Il permet de se concentrer sur le contenu et d'éliminer beaucoup de distractions. Le générateur de sites statiques que j’utilise et dont j’ai fait mention dans l’article Pourquoi créer un site statique ? utilise nativement les fichiers markdown pour la gestion des pages et articles. L’outil Wordpress, qui est sans doute le CMS le plus utilisé pour gérer des sites internet, supporte le format markdown depuis plus d’un an. Il sera ainsi possible de copier-coller du contenu au format markdown dans l’éditeur pour qu’il se mette en forme automatiquement.
Administratif
En poussant un petit peu le markdown et en utilisant notamment du HTML, il est possible de mettre en forme des gabarits de documents administratifs. Pour ma part, par exemple, je m’en sers pour mes courriers. Toute l’entête est déjà prête et il ne reste plus qu’à me concentrer sur le contenu du document.
Editeurs de markdown
Il existe une multitude d’éditeur markdown sur internet (permettant de créer et éditer des fichiers en .md). Certains sont plus spécialisés pour les auteurs ou pour les documentations techniques. Il vous suffit de tapper “Editeur markdown” dans votre moteur de recherche préféré pour trouver votre bonheur.
Typora
Si vous souhaitez quelques chose de simple, léger et clair, je ne peux que vous recommander Typora. C’est un outil (à ce jour totalement gratuit) qui conviendra parfaitement pour débuter en markdown. Son gros point fort c’est que le rendu est en temps réel. Ainsi, si en début de ligne vous tapez # Titre 1 puis Entrée celui-ci se mettra automatiquement en forme.
HackMD
Pour les plus techniques ayant besoin de publier rapidement des documentations ou des Wikis, l’outil HackMD permet cela très simplement. D’ailleurs, si ça vous intéresse voici le lien de mon profil publique : https://hackmd.io/@fabien
Pour conclure je dirais que le mieux pour se faire son propre avis c’est toujours de tester. C’est une façon de rédiger qui me convient mais ce n’est peut être pas le cas de tout le monde.