Le blog de Genma
Vous êtes ici : Accueil » Lifehacking » Lifehacking - Parlons un peu de mes usages de Markdown

Lifehacking - Parlons un peu de mes usages de Markdown

D 12 janvier 2021     H 09:00     A Genma     C 2 messages   Logo Tipee

Depuis l’écriture de mon billet Le Markdown comme langage d’écriture universel ?, je n’ai pas cessé d’utiliser le Markdown. Au contraire. Voici un petit retour d’expérience sur le sujet.

Markdown, quel markdown ?

J’utilise quelques balises de bases qui me suffisent amplement : gras, itatlique, liste à puces, citations et citation de code, section et sous-section. Rien de compliqué ou d’avancé (pas de tableau...). Une syntaxe qui marche dans tous les logiciels que j’utilise (Wiki de Gitlab, Nextcloud...). Je ne me suis donc pas penché sur les problématiques de version ou de compatibilité (s’il y a lieu).

Markdown par défaut pour les écrits

Par défaut, désormais, tous mes écrits sont au format markdown par défaut. Je rédige tous mes comptes-rendus de réunion dans un bloc-notes - éditeur de textes, en utilisant la syntaxe Markdown. J’ai défini des modèles avec des champs à remplir : date, participants, ordre du jour, liste des actions, correspondant à une structure précise. De même pour mes notes. Et tout texte que je rédige d’une façon générale.

Nextcloud

En ajoutant l’extension Markdown, on a la prévisualisation et l’édition des document texte en markdown possible directement dans l’interface web de Nextcloud. J’utilise aussi beaucoup l’application Notes pour des fichiers textes plus courts, ne nécessitant pas une structure ou une organisation d’un dossier "Projet". Je saisis ces notes via l’application mobile essentiellement et les retravaille / finalise depuis un PC.

Pour les billets de blog - SPIP

J’utilise encore - par habitude - un mélange de syntaxe SPIP + balisage HTML... J’ai ajouté un plugin markdown qui permet de saisir des textes au format markdown dans des billets de blogs, en les entourant de deux balises "md" pour que le texte entre ces balises soient interprétées et convertit en HTML.

Pour mon wiki

Mon ancien wiki personnel est sous Dokuwiki avec une extension Markdown. J’ai repris une nouvelle base de connaissances sous la forme d’un Dossier "Wiki" dans Nextcloud avec des sous-dossiers et j’utilise la fonction d’indexation et de recherche de Nextcloud. Mon ancien wiki n’a pas été maintenu, j’en ai lancé d’autres entre-temps (dans des projets Gitlab, donc dans des fichiers markdown. Voir au sujet du Wiki + Gitlab mon billet Lifehacking - Gitlab, outil idéal ?).

Pour la rédaction des mails

Malheureusement, l’extension Thunderbird, Markdown Here, que j’utilisais n’est plus maintenue et n’est donc plus compatible. Professionnellement je suis passé sous Outlook en mode web. Personnellement j’utilise toujours Thunderbird. Ayant pris l’habitude de rédiger en Markdown, je continue et j’envoie mes mails rédigé via une conversion Markdown vers HTML puis copier-coller, les mises en forme (gras etc.) étant alors conservée. C’est un paliatif, c’est mieux que rien.

Conversion - via Pandoc

Le markdown est donc mon format pivot source. Et j’utilise le super outil qu’est Pandoc pour passer d’un fichier texte à un fichier bureautique plus classique.

Les documents textes de type Writer - Libreoffice

Pour les documents textes pour lesquels je souhaite une mise en page un peu évolué, je rédige dans un bloc notes. Puis, dans une première étape, je génère un fichier .odt à partir de mes fichiers markdown via la commande

pandoc mon_fichier_source.md -o mon_fichier_cibe.odt

J’ai alors un fichier .odt, mais avec les styles de base de LibreOffice. J’ai créé un fichier template - modèle, avec un style adapté à mes besoins professionels (couleurs des titres, sections, en-tête et pieds de pages) pour LibreOffice Writer. J’ouvre le fichier .odt formaté issu de la conversion de pandoc, je sélectionne tout, je copie, je colle dans le document template et j’enregistre en renommant le fichier. CTRL+A, CTRL+C, CTRL+V. Le collage dans le document préformaté conserve le formatage cible : les différentes sections, sous-sections adoptent le style du document template, avec les bonnes couleurs, les bonnes mises en forme. Je gagne un temps fou. J’utilise les styles de Libreoffice. Et j’ai la simplicité de l’édition et écriture en markdown au départ.

Cela se passe en donc en deux étapes, qu’il faudrait que j’automatise.

Les présentations et autres supports de conférences

J’ai pendant très longtemps fait mes supports de présentation avec LaTEX / Beamer, sur la base d’un thème que j’avais un peu customisé / personnalisé. J’ai gardé cet état d’esprit, à savoir des slides avec un peu de textes, pas d’effets graphiques évolués ou de mise en page complexe, juste l’ajout d’une ou deux illustrations.

Et pour la réalisation de mes slides Beamer en Markdown, je me suis basé sur ce tutoriel : https://blog.rom1v.com/2014/02/des-slides-beamer-en-markdown/ && https://github.com/rom1v/mdbeamer

Mes supports de présentations sont tout sauf graphique, je n’ai pas un design évolué, des tas de schémas... Mes présentations ont le mérite d’être accessibles, vu que la source, fournie, reste un simple fichier Markdown bien structuré.

Gestion de l’historisation

J’ai des notions et des connaissances en développement. Git est un outil puissant pour la gestion de l’édition de code source. Et qu’est-ce qu’un code source, si ce n’est un texte écrit dans un langage informatique. Je peux donc gérer, si j’en ai le besoin, l’historisation et le suivi des modifications de mes fichiers en gérant les textes dans un dépôt Gitlab.

Conclusion

J’ai parfaitement conscience que ces usages sont les miens et loin d’être adaptés à tout le monde. Mais en terme de flux de productivité, j’ai beaucoup gagné car je peux, depuis un texte écrit en markdown facilement faire l’export, via pandoc, en deux (trois) formats :
- présentation pour l’écran en HTML/Javascript ou présentation PDF de type Beamer ;
- documentation au format odt.
Et je conserve des documents légers, simples, réutilisables (je peux pendre des bouts de l’un et de l’autre).

2 Messages

Un message, un commentaire ?
modération a priori

Ce forum est modéré a priori : votre contribution n’apparaîtra qu’après avoir été validée par un administrateur du site.

Qui êtes-vous ?
Votre message

Ce formulaire accepte les raccourcis SPIP [->url] {{gras}} {italique} <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.