Éditeur Markdown
Écrivez en syntaxe Markdown et prévisualisez en temps réel.
Bienvenue dans l'éditeur Markdown
Vous pouvez utiliser le gras, l'italique et le barré.
- Élément de liste 1
- Élément de liste 2
- Élément imbriqué
- Liste numérotée
- Deuxième élément
Ceci est une citation.
code en ligne et un bloc de code :
console.log("Bonjour");
Vous pouvez aussi ajouter des liens et des tableaux.
| Élément | Valeur |
|---|---|
| A | 1 |
| B | 2 |
Exemples d'utilisation
Rédiger un README ou une documentation technique
Vous voulez voir exactement à quoi ressemblera votre README GitHub ou votre documentation ? Écrivez à gauche et regardez le résultat rendu se mettre à jour instantanément à droite.
Vérifier qu'un tableau ou une liste s'affiche correctement
Pas sûr de la syntaxe des tableaux Markdown ? Voyez exactement comment vos tableaux et listes s'afficheront dès que vous les tapez.
Reprendre là où vous en étiez
Ce que vous écrivez est enregistré automatiquement dans votre navigateur, vous pouvez donc fermer la page et revenir plus tard pour continuer.
Rédiger la description d'une pull request avec une liste de contrôle
Rédigez la description d'une PR avec une liste de contrôle de style '- [ ] Tests added' et des puces imbriquées, et prévisualisez comment GitHub affichera les cases à cocher et l'indentation avant de la coller.
Mettre en forme des notes de version avec des extraits de code
Rédigez des notes de version mêlant titres, journal des modifications à puces et `code` en ligne pour les noms de fonctions, puis vérifiez que les blocs de code délimités pour les commandes de mise à niveau s'affichent avec la bonne coloration du langage.
Questions fréquentes
Ce que j'écris est-il enregistré sur un serveur ?
Non. Toute la rédaction et le rendu de l'aperçu se font entièrement dans votre navigateur. Afin que vous puissiez reprendre là où vous en étiez, votre contenu est enregistré uniquement dans le stockage local (localStorage) de votre navigateur — il n'est jamais envoyé à un serveur ni partagé entre appareils.
Y a-t-il une syntaxe Markdown qui n'est pas prise en charge ?
Titres, gras/italique/barré, listes, citations, code (en ligne et en bloc), liens, images et tableaux (extension GFM) — toute la syntaxe couramment utilisée est prise en charge. Si vous mélangez des balises HTML brutes, elles sont affichées comme du texte brut plutôt qu'exécutées, par sécurité.
Puis-je utiliser ailleurs ce que j'écris ?
Oui. Cliquez sur « Copier » en haut pour copier tout ce que vous avez écrit dans le presse-papiers. Ou cliquez sur « Exporter en README.md » pour le télécharger sous forme de fichier que vous pouvez envoyer directement vers un dépôt GitHub ou ailleurs.
Pourquoi mon simple retour à la ligne n'apparaît-il pas comme une nouvelle ligne dans l'aperçu ?
Cela suit les règles standard de Markdown (CommonMark) : un seul saut de ligne à l'intérieur d'un paragraphe est traité comme une espace, et non comme un retour à la ligne. Pour forcer un retour à la ligne, terminez la ligne par deux espaces ou plus, ou laissez une ligne complètement vide pour commencer un nouveau paragraphe.
Puis-je imbriquer des listes et des citations les unes dans les autres ?
Oui. Indenter un élément de liste de deux espaces l'imbrique sous l'élément précédent, et vous pouvez placer une citation, un bloc de code ou une autre liste dans un élément de liste de la même façon — l'aperçu reflète l'imbrication au fur et à mesure que vous tapez.
La barre d'outils prend-elle en charge des raccourcis clavier ?
Les boutons de la barre d'outils insèrent la bonne syntaxe Markdown (par exemple entourer le texte sélectionné de ** pour le gras) à la position de votre curseur, mais elle est prévue pour une utilisation à la souris ou au tactile — il n'y a pas de raccourcis clavier dédiés en dehors des raccourcis normaux d'édition de texte de votre navigateur et de votre système.
Que devient le contenu si je ferme l'onglet par accident ?
Comme votre contenu est enregistré dans le localStorage au fur et à mesure de la saisie, rouvrir l'outil dans le même navigateur restaure exactement ce que vous aviez. Il n'est perdu que si vous effacez les données de site de votre navigateur ou utilisez un autre navigateur ou appareil.