Aperçu Markdown

Qu'est-ce que Markdown ?

Markdown est un langage de balisage léger créé par John Gruber en 2004. Il utilise des symboles de mise en forme en texte brut — astérisques, dièses, tirets — pour indiquer la structure : titres, gras, italique, listes, liens et blocs de code. Un outil d'aperçu Markdown convertit ce texte brut en HTML formaté pour que tu puisses voir exactement le rendu final avant publication. La spécification originale est décrite dans la documentation Daring Fireball de Gruber, et le format a depuis été formalisé sous le nom CommonMark.

Markdown est devenu le format d'écriture par défaut pour la documentation développeur, les fichiers README, les générateurs de sites statiques (Jekyll, Hugo, Astro), les wikis et les bases de connaissances. GitHub, GitLab, Bitbucket, Stack Overflow, Reddit et Notion supportent tous Markdown nativement. Comme la source est du texte brut, les fichiers Markdown se versionent facilement avec Git, se comparent entre branches et se fusionnent sans conflits sur les sections non chevauchantes d'un fichier.

Un outil d'aperçu Markdown analyse ton entrée et la convertit en HTML en temps réel. Cela te permet de détecter les erreurs de mise en forme, les liens cassés et les imbrications inattendues avant de valider un fichier ou de publier une page. Cet aperçu s'exécute entièrement dans ton navigateur sans aller-retour serveur, ce qui te permet de travailler sur une documentation privée ou sensible sans envoyer de contenu sur le réseau.

Pourquoi utiliser un aperçu Markdown en ligne ?

Écrire du Markdown dans un éditeur brut sans aperçu revient à deviner le rendu. Un aperçu en direct ferme cette boucle de retour instantanément.

Cas d'usage de l'aperçu Markdown

Référence de syntaxe Markdown

Le tableau ci-dessous associe la syntaxe Markdown courante à son rendu et à l'élément HTML correspondant. Il couvre la base CommonMark que pratiquement tous les parseurs Markdown supportent.

Comparatif des variantes Markdown

Différentes plateformes étendent la spécification Markdown originale avec des fonctionnalités supplémentaires. Savoir quelle variante tu cibles t'aide à éviter une syntaxe qui échouerait silencieusement dans un autre moteur de rendu.

Exemples de code : rendu Markdown par programmation

Quand tu dois afficher du Markdown dans une application plutôt que dans un outil navigateur, utilise l'une de ces bibliothèques. Chaque exemple convertit une chaîne Markdown en chaîne HTML.

import { marked } from 'marked'

const md = '# Hello\n\nThis is **Markdown**.'
const html = marked(md)
// → "<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>\n"

// With options
marked.setOptions({ gfm: true, breaks: true })
const gfmHtml = marked('Line one\nLine two')
// → "<p>Line one<br>Line two</p>\n"

import markdown

md = '# Hello\n\nThis is **Markdown**.'
html = markdown.markdown(md)
# → '<h1>Hello</h1>\n<p>This is <strong>Markdown</strong>.</p>'

# With extensions
html = markdown.markdown(md, extensions=['fenced_code', 'tables'])

# Convert a file
with open('README.md') as f:
    html = markdown.markdown(f.read(), extensions=['extra'])

package main

import (
	"bytes"
	"fmt"
	"github.com/yuin/goldmark"
)

func main() {
	source := []byte("# Hello\n\nThis is **Markdown**.")
	var buf bytes.Buffer
	if err := goldmark.Convert(source, &buf); err != nil {
		panic(err)
	}
	fmt.Println(buf.String())
	// → <h1>Hello</h1>
	// → <p>This is <strong>Markdown</strong>.</p>
}

# Convert Markdown file to HTML
pandoc README.md -f markdown -t html -o output.html

# Convert with GitHub Flavored Markdown
pandoc README.md -f gfm -t html --standalone -o output.html

# Pipe from stdin
echo '# Hello **world**' | pandoc -f markdown -t html
# → <h1>Hello <strong>world</strong></h1>

Questions fréquentes