Markdown


Les principales balises Markdown

Pense-bête du langage

Décrit les principales balises du langage Markdown pour ajouter du style à un texte.

Markdown permet d’ajouter du style à un document texte et le transformer en fichier HTML  , PDF ou autre à l’aide de quelques balises. Nous allons voir ici un résumé des plus importantes.


 Présentation

Le but de cet article n’est pas d’expliquer Markdown, mais de présenter un résumé des principales balises à connaître pour créer un document.

 Les titres

Pour définir les différents niveaux de titres :

Syntaxe alternative pour les 2 premiers niveaux :

 Les paragraphes

Pour séparer un paragraphe d’un autre, il suffit d’ajouter un saut de ligne.

 Les styles de texte

En italique

Pour mettre en italique ,entourer la portion de texte du caractère * ou _

En gras

Pour mettre en gras, entourer la portion de texte par 2 caractères * ou 2 caractères _

Exemple :

Remarque : Pour utiliser dans un texte les caractères "*" ou "_" sans qu’ils soient interprétés vous devrez les préfixer par "\".

Texte barré

Pour barrer un texte, entourez-le par 2 ~

 Les listes à puces

Première syntaxe :

seconde syntaxe :

Pour créer des sous-listes, il suffit d’insérer des espaces en début de ligne :

 Les liste numérotées

Pour les lignes numérotées :

 Ligne de séparation

Pour ajouter une ligne de séparation entre 2 paragraphes, utilisez 3 * :

ou 3 -

 Les tableaux

Pour définir un tableau, il suffit de séparer sur chaque lignes, le contenu des cellules par une barre verticale.

Il est possible de justifier le texte dans les colonnes avec la syntaxe suivante :

à droite : ---:
à gauche ; :---
centré : :---:

Exemple :

 Les images

Il est possible d’ajouter une image dans son document. Exemple :

 Les liens

Pour ajouter un lien :

 Formater du code informatique

Il est possible d’insérer du code source informatique, comme des extraits de programmes dans un document.

Il y a lusieurs syntaxes. Si il s’agit d’un simple extrait dans un paragraphe, il faut l’entourer de caractères ` (apostrophe inversée correspondant aux touches AltGr + 8 sur un clavier type PC).

Exemple :

Pour plusieurs lignes de codes, il faut commencer chaque lignes par 4 espaces :

Une syntaxe alternative permettant la coloration syntaxique en fonction du langage est la suivante :

 Les outils

Il existe de nombreux éditeurs de textes qui permettent de visualiser dans une seconde fenêtre, le texte formaté.

La capture suivante montre la visualisation d’un document Markdown dans Visual Studio Code :

Voici l’extension à ajouter dans VS Code :

L’exemple suivant montre un autre logiciel Mado qui est une extension Chrome donc, utilisable sous Chrome OS.

Il existe également de nombreux outils qui permettent de transformer le document écrit en Markdown en document HTML  , PDF ou dans d’autres formats soit sous forme de programmes en lignes de commandes comme md2htmlpdf ou de librairies JavaScript ou PHP pour les principaux.

 Conclusion

Nous venons de voir un résumé des principales balises utilisables.

Il faut savoir qu’il existe plusieurs variantes du langage Markdown et certaines ne supportent pas forcément toutes les syntaxes présentées dans cet article.



Voir en ligne : Documentation anglaise

Article n° 154

Crée par: chris

Créé le: 13 mars

Modifié le: 13 mars

Nombre de visites: 19

Popularité: 22 %

Popularité absolue: 1

Ressources pour le développeur

Mots clés de cet article


SPIP

2003-2020 LePpf
Plan du site | | Contact | RSS 2.0

Visiteurs connectés : 1

Nombre moyen de visites quotidiennes sur le site: 145