## Flux de travail développeur
Comment prévisualiser un README.md GitHub localement sur Mac
Publié en mars 2026
Vous avez modifié le README. Maintenant vous voulez voir le résultat avant de pousser. Voici trois façons de le faire, de la plus lourde à l’instantanée.
## Pourquoi prévisualiser localement
Pourquoi prévisualiser localement ?
- Vérifier la mise en forme avant de pousser. Les tableaux cassés, les liens brisés et les blocs de code mal formés sont embarrassants dans un dépôt public. Repérez-les avant
git push. - Travailler hors ligne. Avions, trains, cafés avec un wifi médiocre. Votre README ne devrait pas nécessiter de connexion internet pour être relu.
- Relire les modifications de documentation dans les PR. Quand une pull request met à jour le README, vous voulez voir le résultat rendu à côté du diff de code.
- Éviter le cycle commit-push-vérification. Pousser un commit juste pour voir le rendu de votre README sur GitHub pollue votre historique git et fait perdre du temps.
## Méthode 1
grip (outil CLI)
pip install grip grip README.md
grip rend votre Markdown en utilisant l’API GitHub, vous obtenez ainsi un rendu pixel-perfect de GitHub dans votre navigateur à localhost:6419.
Avantages
- Rendu identique à GitHub (utilise leur API)
Inconvénients
- Nécessite Python installé
- Nécessite un jeton API GitHub pour une utilisation intensive (limité sinon)
- Lance un serveur local qu’il faut démarrer et arrêter
- Pas adapté au mode hors ligne (appelle l’API GitHub)
## Méthode 2
Aperçu intégré de VS Code
Open README.md in VS Code Cmd + Shift + V → preview pane
VS Code dispose d’un aperçu Markdown intégré. Ouvrez le fichier, appuyez sur le raccourci clavier et un panneau latéral affiche le résultat rendu.
Avantages
- Déjà installé chez la plupart des développeurs
- Fonctionne hors ligne
Inconvénients
- Lancer un IDE complet pour prévisualiser un README, c’est excessif
- Le rendu de l’aperçu ne correspond pas exactement à GitHub (pas de support des callouts, style de tableau différent)
- Lié à votre éditeur — impossible de simplement double-cliquer sur un fichier
## Méthode 3 (Recommandée)
ShowMeMyMD — double-cliquez, c’est tout
git clone <repo> Double-cliquez sur README.md Terminé.
ShowMeMyMD est une visionneuse Markdown native pour macOS. Définissez-la comme application par défaut pour les fichiers .md et chaque README s’ouvre en aperçu rendu instantanément. Pas de CLI. Pas de serveur. Pas de configuration.
Support complet du GitHub Flavored Markdown :
- Tableaux avec alignement
- Listes de tâches avec cases à cocher
- Blocs de code délimités avec coloration syntaxique
- Callouts GitHub :
NOTE,TIP,WARNING,IMPORTANT,CAUTION
Clonez, double-cliquez sur README.md, terminé.
## Comparaison
Comparaison côte à côte
| Outil | Configuration | Fidélité GFM | Rapidité | Hors ligne |
|---|---|---|---|---|
| grip | Python + pip install | Exact (API GitHub) | Lent (réseau) | Non |
| VS Code | Déjà installé | Partiel | Rapide | Oui |
| ShowMeMyMD | Installation unique depuis le Mac App Store | GFM complet + callouts | Instantané | Oui |
## À lire aussi
En savoir plus sur ShowMeMyMD en tant que visionneuse Markdown pour Mac. Découvrez comment il s’intègre dans un flux de travail développeur. Ou lisez notre guide sur les callouts GitHub.
Arrêtez de pousser pour vérifier votre README
Double-cliquez sur n’importe quel fichier .md et voyez-le rendu instantanément. GitHub Flavored Markdown, coloration syntaxique, quatre thèmes. 2,99 $ sur le Mac App Store.