Aperçu Markdown

Markdown est un langage de balisage léger pour créer du texte formaté en utilisant une syntaxe en texte brut. Populaire pour la documentation, les fichiers README et la prise de notes, il se convertit en HTML pour l'affichage. Cet outil prévisualise le Markdown avec rendu en direct, extrait la structure du document (titres, liens, images) et peut convertir en HTML.

Specifications

• CommonMark Spec
• GitHub Flavored Markdown
• Markdown Guide

Cas d'utilisation courants

• Prévisualiser les fichiers README.md avant le commit
• Examiner le formatage de la documentation
• Extraire tous les liens d'un document pour validation
• Convertir du Markdown en HTML pour l'intégration
• Analyser la structure et la navigation du document

Fonctionnalites

• Aperçu en direct avec rendu HTML
• Extraire la structure du document (titres en table des matières)
• Lister tous les liens et images du document
• Détecter et afficher les blocs de code avec indications de langage
• Analyser le frontmatter (métadonnées YAML)
• Convertir en sortie HTML propre
• Statistiques de nombre de mots et de caractères

Exemples

# My Project

A brief description of what this project does.

## Installation

```bash
npm install my-project
```

## Features

- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework

## Links

- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)

Conseils

• Utilisez # pour les titres (# H1, ## H2, ### H3, etc.).
• Les blocs de code utilisent des triples accents graves avec un identifiant de langage optionnel.
• Les liens utilisent la syntaxe [texte](url) ; les images utilisent .
• Le frontmatter entre les lignes --- peut contenir des métadonnées YAML.

Comprendre Aperçu Markdown

Markdown est un langage de balisage léger créé par John Gruber en 2004, conçu pour être lisible en texte brut tout en se convertissant proprement en HTML. Sa syntaxe utilise des caractères de ponctuation qui suggèrent visuellement leur formatage : # pour les titres, * pour l'emphase, - pour les listes et les accents graves pour le code. Les fichiers Markdown restent utiles même sans rendu, c'est pourquoi le format domine pour la documentation, les fichiers README et la rédaction technique.

La spécification CommonMark (2014) a résolu les nombreuses ambiguïtés du Markdown original. CommonMark définit précisément comment les cas limites sont gérés, et la plupart des analyseurs modernes l'implémentent. GitHub Flavored Markdown (GFM) étend CommonMark avec les tableaux, les listes de tâches, le texte barré, les URL auto-liées et les blocs de code délimités avec coloration syntaxique.

GFM est le standard de facto pour les fichiers README, les descriptions de pull requests, les commentaires d'issues et les sites de documentation. La plupart des plateformes de documentation (Notion, Docusaurus, MkDocs, GitBook) prennent en charge GFM ou un sur-ensemble de celui-ci.

Le frontmatter est une convention courante pour ajouter des métadonnées structurées aux fichiers Markdown. Un bloc YAML délimité par des lignes --- en haut du fichier peut contenir le titre, la date, l'auteur et les tags utilisés par les générateurs de sites statiques (Astro, Hugo, Jekyll, Next.js) pour construire la navigation et les mises en page.

En pratique, "Markdown" fait presque toujours référence à CommonMark ou GFM. La spécification Markdown originale laissait de nombreux cas limites indéfinis, et CommonMark a résolu ces ambiguïtés avec une spécification stricte. GFM étend CommonMark avec les tableaux, les listes de tâches, le texte barré et les URL auto-liées. Lors de l'évaluation d'un analyseur ou d'un moteur de rendu Markdown, vérifier sa conformité CommonMark est un indicateur fiable de la qualité de gestion des cas limites.

Les tableaux en GFM utilisent des pipes (|) pour séparer les colonnes et des tirets (-) pour la ligne de séparation d'en-tête. L'alignement des colonnes est contrôlé avec des deux-points dans le séparateur : :--- pour aligné à gauche, :---: pour centré et ---: pour aligné à droite. Les tableaux sont une extension GFM et ne font pas partie de la syntaxe Markdown originale. Le frontmatter, délimité par des lignes --- au tout début du fichier, est un bloc de métadonnées YAML utilisé par les générateurs de sites statiques pour les métadonnées de page comme le titre, la date, la mise en page et les tags. GitHub affiche le frontmatter sous forme de tableau en haut du fichier, bien que tous les moteurs de rendu ne le traitent pas.

Les blocs de code délimités utilisent des triples accents graves avec un identifiant de langage optionnel après les accents graves d'ouverture — par exemple, une ligne avec trois accents graves suivis de "javascript" démarre un bloc JavaScript avec coloration syntaxique. Les identifiants de langage disponibles dépendent de la plateforme de rendu. L'indentation du code de quatre espaces crée également un bloc de code, mais sans la possibilité de spécifier un langage pour la coloration.