Markdown est un langage de balisage léger avec une syntaxe de formatage de texte brut. Sa conception lui permet d’être converti en de nombreux formats de sortie, mais l’outil d’origine du même nom ne prend en charge que le HTML. Markdown est souvent utilisé pour formater des fichiers Lisez-moi, pour écrire des messages dans des forums de discussion en ligne et pour créer du texte enrichi à l’aide d’un éditeur de texte brut.
Étant donné que la description initiale de Markdown contenait des ambiguïtés et des questions sans réponse, les implémentations qui sont apparues au fil des ans ont des différences subtiles et beaucoup viennent avec des extensions de syntaxe.
Histoire
John Gruber a créé le langage Markdown en 2004 en collaboration avec Aaron Swartz sur la syntaxe, dans le but de permettre aux gens «d’écrire en utilisant un format de texte brut facile à lire et à écrire». Son objectif de conception clé est la lisibilité. Que la langue soit lisible telle quelle.
Pour écrire en utilisant un format de texte brut facile à lire et à écrire
À cette fin, son inspiration principale est les conventions existantes pour le balisage du texte brut dans les e-mails, bien qu’il s’inspire également des langages de balisage antérieurs, notamment setext, Textile et reStructuredText.
Exemple
$(window).scroll(function () {
// this will work when your window scrolled.
var scroll = $(window).scrollTop(); //getting the scrolling height of window
if (scroll > 100) {
$(".header").addClass("header-scrolled");
} else {
$(".header").removeClass("header-scrolled");
}
});
Saveurs Markdown
Il existe plusieurs versions différentes de markdown
CommonMark
À partir de 2012, un groupe de personnes comprenant Jeff Atwood et John MacFarlane a lancé ce qu’Atwood a qualifié d’effort de normalisation. Un site Web communautaire vise désormais à «documenter divers outils et ressources disponibles pour les auteurs et développeurs de documents, ainsi que pour les implémenteurs des différentes implémentations de démarques».
GitHub Flavored Markdown (GFM)
En 2017, GitHub a publié une spécification formelle de leur GitHub Flavored Markdown (GFM) basée sur CommonMark. Il suit exactement la spécification CommonMark, sauf pour les tables, les barrés, les liens automatiques et les listes de tâches, que la spécification GitHub a ajoutés en tant qu’extensions. GitHub a également modifié l’analyseur utilisé sur leurs sites en conséquence, ce qui a nécessité la modification de certains documents. Par exemple, GFM exige maintenant que le symbole de hachage qui crée un titre soit séparé du texte de l’en-tête par un caractère espace. L’utilisateur crée le sien.
Markdown Extra
Markdown Extra est un langage de balisage léger basé sur Markdown implémenté en PHP (à l’origine), Python et Ruby. Il ajoute des fonctionnalités non disponibles avec la syntaxe Markdown simple. Markdown Extra est pris en charge dans certains systèmes de gestion de contenu tels que, par exemple, Drupal.
Markdown Extra ajoute les fonctionnalités suivantes à Markdown:
- balisage markdown à l’intérieur des blocs HTML
- éléments avec attribut id / class
- “blocs de code clôturés” qui s’étendent sur plusieurs lignes de code
- tableaux
- listes de définitions
- notes de bas de page
- abréviations