Qu'est-ce que le Markdown ?

Le Markdown est un langage de balisage léger qui utilise des symboles simples dans du texte brut pour appliquer une mise en forme. Créé par John Gruber en 2004, il se distingue par sa facilité de lecture et d'écriture. Il est largement utilisé sur GitHub, GitLab et diverses plateformes de blogs.

En quoi le GFM (GitHub Flavored Markdown) diffère-t-il du Markdown standard ?

Le GFM est une spécification Markdown étendue par GitHub. Il ajoute au Markdown standard des fonctionnalités telles que les tableaux, les listes de contrôle (Task Lists), le texte barré, les liens automatiques et la spécification du langage pour les blocs de code. Il est particulièrement utile pour la rédaction de documentation technique.

Comment appliquer la coloration syntaxique aux blocs de code ?

Il suffit de spécifier le nom du langage après les backticks (```) qui ouvrent le bloc de code. Par exemple, en commençant par ```javascript, la coloration syntaxique JavaScript sera appliquée. De nombreux langages sont pris en charge : Python, TypeScript, CSS, etc.

Puis-je partager le Markdown rédigé avec d'autres personnes ?

Il n'y a pas de fonction de partage direct par URL, mais vous pouvez télécharger le contenu rédigé en fichier .md ou copier le HTML rendu pour le partager par e-mail, messagerie, etc. Le téléchargement sur un dépôt GitHub assure un rendu automatique.

Le contenu saisi est-il stocké sur un serveur ?

Non. Toutes les opérations d'édition et de rendu Markdown sont traitées côté client dans votre navigateur. Le contenu saisi n'est jamais transmis à un serveur, ce qui vous permet de rédiger en toute tranquillité des documents personnels ou sensibles.

Markdown

Aperçu

Guide de syntaxe Markdown

Titres

# H1→

H1

## H2→

H2

### H3→

H3

Emphase

**gras** ou __gras__→

Bold

*italique* ou _italique_→

Italic

~~barré~~→

~~Strike~~

**_gras italique_**→

Both

Listes

- Liste non ordonnée→

Item

1. Liste ordonnée→

Item

Liens

[Texte du lien](URL)→

Link

<https://auto.link>→

https://auto.link

Images

![Texte alt](URL image)

![alt](URL "titre")

Code

`code en ligne`→

code

```lang ... ```

Citation

> Citation→

Quote

>> Citation imbriquée→

Nested

Ligne horizontale

---

***

___

Échappement

\* Échapper les caractères spéciaux→

*text*

\# \[ \]

GitHub Flavored Markdown (GFM)

Tableau

| En-tête1 | En-tête2 |

|---|---|

| Cellule1 | Cellule2 |

Liste de tâches

- [x] Élément terminé→

Done

- [ ] Élément non terminé→

Todo

Lien automatique

https://example.com→

https://example.com

user@email.com→

user@email.com

Astuces

Aperçu en temps réel

Entrez du Markdown à gauche et voyez instantanément le résultat rendu à droite.

Support GFM

Support complet de GitHub Flavored Markdown. Utilisez des tableaux, des listes de tâches et des liens automatiques.

Exporter

Téléchargez votre Markdown en fichier .md ou copiez le HTML rendu.

Qu'est-ce qu'un aperçu Markdown ?

L'aperçu Markdown est un outil en ligne permettant de convertir en temps réel du texte rédigé en syntaxe Markdown en HTML. Il prend entièrement en charge GitHub Flavored Markdown (GFM), incluant les tableaux, les listes de tâches et la coloration syntaxique du code.

Aperçu en temps réel avec rendu simultané à la saisie
Prise en charge complète de GitHub Flavored Markdown (GFM)
Coloration syntaxique (Syntax Highlighting) des blocs de code
Prise en charge des syntaxes étendues : tableaux, listes de contrôle, texte barré, etc.
Copie du document rédigé en HTML ou téléchargement en fichier .md
Guide de syntaxe Markdown intégré, accessible même aux débutants

Mode d'emploi

1
Saisie du Markdown
Saisissez du texte en utilisant la syntaxe Markdown dans l'éditeur de gauche. Utilisez # pour les titres, ** pour le gras, - pour les listes, etc.
2
Vérification de l'aperçu en temps réel
Vérifiez instantanément le résultat du rendu de votre Markdown dans la zone d'aperçu à droite.
3
Consultation du guide de syntaxe
Lorsque vous ne vous souvenez plus d'une syntaxe, ouvrez le guide de syntaxe Markdown intégré pour consulter l'utilisation et les exemples de chaque syntaxe.
4
Importation de fichier
Si vous disposez d'un fichier .md existant, vous pouvez l'importer via la fonction d'ouverture de fichier pour l'éditer et le prévisualiser.
5
Exportation des résultats
Téléchargez le document finalisé en fichier .md ou copiez le HTML rendu pour le coller ailleurs.

Questions fréquentes

Conseils d'utilisation

Lors de la rédaction d'un README.md, utilisez cet outil pour prévisualiser le rendu avant de le publier sur GitHub.
Les tableaux se créent facilement avec le caractère pipe | et le tiret -, et les deux-points (:) permettent de spécifier l'alignement.
Pour insérer une image, utilisez la syntaxe ![texte alternatif](URL) et vous pouvez utiliser directement une URL d'image web.
Les listes de contrôle avec - [ ] et - [x] permettent de créer des listes de tâches, très utiles pour la gestion de projet.
À l'intérieur des blocs de code, la syntaxe Markdown est affichée telle quelle sans échappement, ce qui convient parfaitement à la rédaction de documentation sur la syntaxe.