Visionneuse et aperçu README.md

Vérifiez un README avant de le pousser. Ouvrez le fichier, collez le texte ou déposez un lien GitHub et voyez badges, tableaux, blocs de code, listes de tâches, alertes et diagrammes Mermaid rendus comme GitHub les affiche.

Prévisualiser un README

Gratuit · sans inscription · fonctionne dans votre navigateur, rien n'est envoyé

Le README de markdown-it ouvert depuis une URL GitHub, rendu avec badges, alertes et code en GitHub Dark — Un vrai README ouvert directement depuis un lien GitHub : badges, alertes, tableaux et code s'affichent comme sur GitHub.

Ouvrir un README depuis GitHub ou depuis le disque

Collez une URL GitHub telle que https://github.com/user/repo/blob/main/README.md dans Ouvrir → Depuis une URL — la visionneuse la transforme en lien vers le fichier brut et le rend. Les liens Gist fonctionnent de la même façon. Pour un projet sur votre machine, déposez le README.md sur la page ou collez son contenu dans l'éditeur.

Tout ce que GitHub rend, rendu de la même façon

Le GitHub-Flavored Markdown est un dialecte précis, et les README s'appuient sur ses extras : tableaux à barres verticales, listes de tâches - [ ], ~~barré~~, URL automatiquement liées, alertes > [!NOTE] / [!WARNING], sections <details> pour les longues instructions d'installation, badges shields.io, ancres de titre relatives et code délimité avec étiquettes de langage. Tout cela est rendu ici, avec les mêmes identifiants de titre que GitHub génère, donc vos liens internes continuent de fonctionner. Les diagrammes Mermaid — que GitHub dessine aussi — sont rendus également.

Corrigez avant le commit

Passez en disposition Côte à côte et modifiez le README avec l'aperçu en direct : la barre d'outils insère tableaux et listes de tâches, les raccourcis gèrent gras, liens et titres, et le plan montre si la structure de vos sections se lit bien. Téléchargez le .md quand il vous convient, ou copiez le HTML rendu pour un site de projet. Un dépôt ne contient pas que des README : les fichiers d'instructions comme CLAUDE.md et AGENTS.md s'ouvrent de la même façon — voir la visionneuse CLAUDE.md.

En action

Alertes Note, Important, Warning et Caution façon GitHub, une citation et une section details repliable dans le thème GitHub Dark — Alertes façon GitHub, citations et sections <details> repliables, en GitHub Dark.

Blocs de code TypeScript, Python, Bash et diff avec coloration syntaxique, étiquettes de langage et boutons de copie — Les blocs de code ont une étiquette de langage, une coloration syntaxique pour plus de 50 langages et un bouton de copie — ici le thème One Dark.

Formule KaTeX en mode affichage et organigramme Mermaid rendus dans l'aperçu — Les formules KaTeX et les organigrammes Mermaid sont rendus directement dans le document.

Comment ça marche

1
Collez un lien README GitHub dans Ouvrir → Depuis une URL, ou déposez le fichier sur la page.
2
Lisez-le rendu, avec badges, tableaux, code et diagrammes en place.
3
Modifiez en mode Côte à côte, puis téléchargez le README.md mis à jour.

Ce que vous obtenez

Liens GitHub convertis

Les URL blob et Gist deviennent automatiquement des fichiers bruts.

GFM complet

Tableaux, listes de tâches, alertes, notes de bas de page, details, badges, liens automatiques, emoji.

Diagrammes Mermaid

Les diagrammes d'architecture et de flux sont rendus sur place.

Thèmes sombres et clairs

Vérifiez comment le README se lit en GitHub Dark comme en Light.

Éditer avec aperçu

Corrigez les problèmes de mise en forme et téléchargez le fichier corrigé.

Privé

Les fichiers locaux ne quittent jamais votre navigateur ; les récupérations par URL ne sont pas stockées.

Questions fréquentes

Le rendu sera-t-il identique à GitHub ?

Les règles Markdown et les identifiants de titre correspondent au GitHub-Flavored Markdown, et les thèmes GitHub Light / Dark utilisent les couleurs de GitHub. De légères différences d'espacement sont possibles, mais structure, tableaux, code et alertes sont rendus à l'identique.

Puis-je prévisualiser le README d'un dépôt privé ?

Pas par URL, car le serveur ne peut pas s'authentifier auprès de GitHub. Téléchargez plutôt le fichier et déposez-le sur la page — il reste sur votre appareil.

Les liens d'images relatifs fonctionnent-ils ?

Les images avec des URL absolues sont rendues. Les chemins relatifs comme docs/logo.png ne peuvent pas être résolus pour un fichier local ; en ouvrant depuis une URL GitHub, utilisez des chemins raw.githubusercontent.com.

Les badges sont-ils affichés ?

Oui. Les badges sont des images ordinaires avec des URL absolues et sont rendus normalement.

Puis-je rendre un README d'un autre site que GitHub ?

Oui, toute URL publique renvoyant un fichier Markdown fonctionne. Les pages HTML sont rejetées pour que vous sachiez qu'il faut utiliser le lien brut.

Outils associés

Prêt quand vous l'êtes

Collez du Markdown, déposez un fichier ou ouvrez une URL — l'aperçu apparaît instantanément et tout reste sur votre appareil.

Ouvrir Markdown Viewer