Prévisualisation Markdown

Qu’est-ce que le Markdown ?

Le Markdown est un langage de balisage leger qui utilise une syntaxe de formatage en texte brut pour creer des documents structures. Il a ete concu pour etre lisible tel quel — meme sans rendu — tout en etant trivialement convertible en HTML et d’autres formats de sortie.

Cree par John Gruber et Aaron Swartz en 2004, Markdown est ne d’une philosophie simple : ecrire pour le web devrait ressembler a ecrire un e-mail. Au lieu d’envelopper le texte dans des balises HTML, vous utilisez des symboles intuitifs comme # pour les titres, * pour la mise en valeur et - pour les listes. Le texte source brut reste lisible et la sortie rendue est du HTML propre.

Aujourd’hui, Markdown est omnipresent. Il alimente les fichiers README sur GitHub et GitLab, la documentation sur Read the Docs et Docusaurus, les applications de prise de notes comme Obsidian et Notion, les plateformes de blog comme Ghost et les generateurs de sites statiques comme Astro, Hugo et Jekyll.

Syntaxe de base

La syntaxe principale de Markdown couvre les elements necessaires a la plupart des taches de redaction :

Titres

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Chaque symbole # correspond a un niveau de titre HTML (<h1> a <h6>). Utilisez un seul # pour le titre de la page et augmentez les niveaux pour les sous-sections.

Mise en valeur

Syntaxe	Rendu	HTML
*italique* ou _italique_	italique	<em>
**gras** ou __gras__	gras	<strong>
***gras italique***	gras italique	<strong><em>
`code en ligne`	code en ligne	<code>

Listes

Les listes non ordonnees utilisent -, * ou + comme marqueurs de puces. Les listes ordonnees utilisent des numeros suivis d’un point :

- Item one
- Item two
  - Nested item

1. First step
2. Second step
3. Third step

Liens et images

[Texte du lien](https://example.com)
![Texte alternatif](image.png)

Blocs de code

Les blocs de code delimites utilisent des triples accents graves avec un identifiant de langage optionnel pour la coloration syntaxique :

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

Citations

> Ceci est une citation.
> Elle peut s'etendre sur plusieurs lignes.

Les variantes de Markdown

La specification originale de Markdown laissait de nombreux cas limites indefinis, conduisant a des implementations divergentes. Plusieurs “variantes” ont emerge pour y remedier :

Variante	Maintenue par	Ajouts principaux
CommonMark	Equipe CommonMark	Specification formelle, suppression des ambiguites
GFM (GitHub Flavored)	GitHub	Tableaux, listes de taches, texte barre, liens automatiques
MDX	Equipe MDX	Composants JSX dans le Markdown
MultiMarkdown	Fletcher Penney	Notes de bas de page, citations, metadonnees
Pandoc Markdown	Equipe Pandoc	Notes de bas de page, listes de definitions, formules mathematiques

CommonMark (2014) est ce qui se rapproche le plus d’un standard. Il fournit une specification formelle et une suite de tests exhaustive qui resout les ambiguites de la description originale de Gruber. La plupart des analyseurs Markdown modernes (markdown-it, remark, pulldown-cmark) implementent CommonMark comme base.

GitHub Flavored Markdown (GFM) est un sur-ensemble de CommonMark utilise par GitHub, GitLab et de nombreuses plateformes de documentation. Ses ajouts les plus notables sont :

• Tableaux : Colonnes separees par des barres verticales avec prise en charge de l’alignement
• Listes de taches : - [ ] pour les elements non coches et - [x] pour les elements coches
• Texte barre : ~~texte supprime~~
• URL auto-liees : Les URL brutes sont automatiquement converties en liens cliquables
• Coloration syntaxique : Blocs de code delimites avec identifiants de langage

Markdown vs texte enrichi

Aspect	Markdown	Texte enrichi (WYSIWYG)
Format source	Texte brut	Binaire ou HTML
Controle de version	Excellent (diffs textuels)	Mediocre (diffs binaires)
Portabilite	Universelle	Dependante de l’editeur
Courbe d’apprentissage	Syntaxe minimale	Aucune (pointer et cliquer)
Collaboration	Compatible Git	Necessite des outils specialises
Formats de sortie	HTML, PDF, DOCX, diaporamas	Generalement un seul format
Rendu	Necessite un analyseur	Instantane dans l’editeur

Markdown excelle dans les contextes techniques ou le controle de version, la portabilite et la collaboration sont importants. Sa nature en texte brut signifie que les fichiers Markdown produisent des diffs propres dans Git, peuvent etre edites avec n’importe quel editeur de texte et sont facilement convertibles en plusieurs formats de sortie.

Les editeurs de texte enrichi (Google Docs, Word, Notion) sont mieux adaptes aux utilisateurs non techniques qui preferent le formatage visuel et la collaboration en temps reel sans apprendre de syntaxe.

Cas d’usage courants

• Fichiers README : Chaque projet open source sur GitHub utilise README.md comme page d’accueil du projet
• Documentation technique : Docusaurus, MkDocs, Read the Docs, VitePress et Astro utilisent tous Markdown comme format de contenu principal
• Articles de blog : Les generateurs de sites statiques (Hugo, Jekyll, Gatsby, Astro) transforment les fichiers Markdown en articles de blog avec des metadonnees issues du frontmatter YAML
• Prise de notes : Obsidian, Logseq et Bear utilisent Markdown comme format natif, permettant la portabilite et l’interoperabilite
• Suivi de tickets : GitHub Issues, GitLab Issues et Jira prennent tous en charge Markdown pour le formatage des descriptions et des commentaires
• Messagerie et chat : Slack, Discord et Microsoft Teams prennent en charge un sous-ensemble de Markdown pour le formatage des messages
• Presentations : Des outils comme Marp, Slidev et reveal.js convertissent le Markdown en diaporamas