4 Mar 2023

Utiliser Markdown

par | Classé dans : Programmation | 0

Depuis sa création le langage HTML est utilisé pour mettre en forme du texte (gras, italique, liste, paragraphe, image…) assez facilement pour peu que la mise en page ne soit pas trop complexe.  Mais au fil du temps la syntaxe HTML s’est améliorée et est devenue plus complexe. HTML utilise maintenant beaucoup plus de code qu’auparavant et devient parfois difficile à maintenir manuellement.

C’est la qu’intervient le nouveau langage Markdown. Ce langage permet de mettre en forme un texte grâce à des balises simples. Les éléments les plus courants d’HTML sont disponible mais avec une syntaxe bien plus simple et le document reste lisible.

Voici un exemple HTML

<h1>TITRE H1</h1>
<ul>
<li>Item1</li>
<li>Item2</li>
</ul>
<h3>Titre h3</h3>

Et l’équivalent en Markdown 

#TITRE H1

- Item1
- Item2

Vous constatez que la syntaxe est bien plus simple. L’autre énorme intérêt de Markdown est que le texte reste tout à fait lisible, contrairement au code HTML. Un autre énorme avantage de Markdown c’est qu’il est facilement transposable dans d’autres formats : HTML, PDF…

C’est bien beau tout ça me direz vous mais aucun navigateur ne comprend Markdown, donc ce n’est pas très pratique ? Et bien je vais vous donner un exemple.

Vous maintenez un site avec beaucoup de contenu (pages, articles). Au lieu d’utiliser l’éditeur intégré de votre CMS (WordPress, Drupal…) vous utilisez un éditeur Markdown pour rédiger vos documents. Donc au final vous utilisez un éditeur pour vos rédactions et après transformation en HTML il est facile de l’intégrer dans votre CMS et il sera tout aussi facile de générer un PDF de votre document. Les mise à jour des textes sont simplifiés.

Pour ma part c’est en cherchant un moyen de gérer la documentation de MyMVC que j’ai commencé à utiliser Markdown. Il me fallait un moyen rapide pour rédiger des docs au format HTML (sur Mac et Windows) sans la lourdeur d’écriture du langage HTML et il fallait également pouvoir générer des versions PDF dans l’objectif de  faire une documentation globale au format PDF.

Voici une liste de quelques éditeurs Markdown :

Vous trouverez également sur ces liens de nombreuses autres informations :

Pour finir pour les plus geeks.. sachez qu’il est possible de configurer l’éditeur SublimeText pour qu’il gère le Markdown, vous trouverez ici quelques explications :

Enfin pour finir voici deux liens qui regroupent toutes les balises utilisables avec Markdown :

J’en ai oublié beaucoup, donc n’hésitez pas via les commentaires à proposer d’autres éditeurs, la liste sera complétée.