Éditeur de README sur Mac
Un README.md est du Markdown ordinaire : des titres, des listes, des tableaux, des blocs de code. Marko l’ouvre mis en forme sur votre Mac, vous laisse corriger le texte et les tableaux, puis enregistre un .md qui reste lisible sur GitHub. Vous ne cassez pas la compatibilité du fichier.
Ouvrir le README mis en forme
Dans un éditeur de code, un README s’affiche en texte brut, avec ses dièses et ses barres de tableau. Pour relire la présentation réelle, il faut aller sur GitHub. Marko montre cette présentation directement sur votre Mac.
- Ouvrez le fichier README.md dans Marko avec Fichier > Ouvrir.
- Passez en mode Visuel : titres, listes, cases à cocher et tableaux prennent leur place.
- Repassez en mode Source quand vous voulez voir le balisage exact.
Corriger les sections qui vieillissent
Un README accumule les petits écarts avec le temps. Voici les endroits à relire en priorité :
| Section | Ce qui se corrige dans Marko |
|---|---|
| Commandes d’installation | Mettre à jour une commande ou une version dans le bloc de code |
| Tableau de configuration | Ajouter ou retirer une ligne, cellule par cellule, sans compter les barres |
| Liste de tâches | Cocher d’un clic ce qui est fait |
| Liens et chemins | Corriger une adresse ou un chemin de fichier dans le texte |
Ce que vous ne touchez pas reste écrit tel quel. Marko conserve le balisage qu’il ne connaît pas et les espaces du fichier, donc une section déjà en place garde sa forme.
Garder la compatibilité GitHub
Marko affiche le Markdown enrichi de GitHub (GFM) : les tableaux sont dessinés et les cases à cocher d’une liste de tâches sont rendues. Pour les alertes GitHub, les badges, le HTML inséré et les émojis en :rocket:, leur texte est conservé dans le fichier ; leur rendu propre à GitHub se vérifie sur le dépôt.
À l’enregistrement, Marko écrit du Markdown ordinaire. Le fichier reste un .md que GitHub relit et que vos contributeurs rouvrent dans l’éditeur de leur choix. Marko n’a pas d’intégration Git : il ouvre et enregistre le fichier, vous le commitez ensuite avec votre outil habituel.
Avant de valider le commit
Marko vise une sortie propre : ce que vous ne modifiez pas garde ses octets, et cocher une case n’écrit que les trois caractères de son état. Deux ou trois vérifications évitent une surprise dans la différence :
- Renommer un titre change son ancre sur GitHub ; mettez à jour les liens internes en
#sectionqui pointaient dessus. - Vérifiez que les liens relatifs et les chemins d’image mènent toujours au bon endroit.
- Relisez la différence dans votre outil Git, puis validez.
Partager une version à lire
Parfois, un README doit partir à quelqu’un qui ne va pas sur le dépôt : une relecture, une pièce jointe à un message. Choisissez Fichier > Exporter en PDF… ; le document sort paginé au format A4, avec sa mise en forme. Le .md reste la source du projet. La production du PDF se fait sur votre Mac, sans rien envoyer.
Questions fréquentes
Modifier un README dans Marko casse-t-il sa compatibilité GitHub ?
Non. Marko enregistre du Markdown ordinaire et conserve le balisage qu’il ne connaît pas. Le fichier reste un .md que GitHub relit normalement.
Les tableaux et les cases à cocher sont-ils rendus ?
Oui. Marko affiche le Markdown enrichi de GitHub : les tableaux sont dessinés et les cases à cocher d’une liste de tâches se cochent d’un clic.
Marko est-il relié à Git ou à GitHub ?
Non. Marko n’a pas d’intégration Git. Il ouvre et enregistre le fichier README.md sur votre disque ; vous commitez ensuite avec votre outil habituel.
Essayez sur votre propre fichier. Ouvrez un .md que votre IA vient d’écrire, corrigez-le et exportez-le. Marko fonctionne sur Mac Apple Silicon, macOS 12 ou plus récent.
Essai complet de 14 jours, sans compte ni carte bancaire. Voir les tarifs