Markdown Buddy › Aperçu Markdown dans Xcode
Aperçu Markdown dans Xcode
Xcode affiche les fichiers Markdown en source brute. Pour un README, un CHANGELOG ou une note d'architecture, cela revient à lire le balisage au lieu du document. Markdown Buddy fournit une extension Source Editor native : depuis le menu Editor, le fichier que vous consultez s'ouvre mis en forme, sans quitter votre projet.
Installer l'extension
- Installez Markdown Buddy depuis le Mac App Store et lancez-le une fois, pour que macOS enregistre l'extension qu'il porte.
- Ouvrez Réglages Système, allez dans Général puis Ouverture et extensions, et activez Markdown Buddy sous Xcode Source Editor.
- Redémarrez Xcode. Les extensions sont lues au lancement : un Xcode déjà ouvert ne verra pas celle que vous venez d'activer.
- Ouvrez un fichier .md, puis utilisez Editor puis Markdown Buddy. Vous pouvez lui attribuer un raccourci clavier dans les réglages d'Xcode, rubrique Key Bindings.
Pourquoi c'est utile sur un dépôt
La documentation d'un projet vit à côté du code, et c'est l'éditeur de code qui la montre le plus mal.
- Un README avec des tableaux et des badges est illisible en source brute
- Un CHANGELOG est une longue liste imbriquée, où l'indentation porte le sens
- Une note d'architecture contient souvent des diagrammes Mermaid, qu'Xcode affiche comme du texte encadré
- Les liens relatifs entre documents ne se suivent pas depuis la vue source
Au-delà de l'extension
La même app ouvre un dossier entier comme espace de travail, cherche dans tous ses fichiers .md et dessine le graphe des liens entre vos documents en signalant ceux qui sont cassés. Sur un dépôt dont la documentation a grossi, c'est souvent plus utile que l'aperçu lui-même.
Si la commande n'apparaît pas dans le menu Editor
- Vérifiez que l'extension est activée dans Réglages Système, rubrique Général, Ouverture et extensions, section Xcode Source Editor.
- Quittez complètement Xcode et relancez-le. La liste des extensions n'est lue qu'au démarrage.
- Lancez Markdown Buddy une fois depuis le dossier Applications, puis réessayez.
- La commande n'apparaît que si le document au premier plan est un fichier Markdown. Sur un fichier .swift, elle reste masquée.
Questions fréquentes
Est-ce que cela modifie mon projet ?
Non. L'extension se contente de lire le document ouvert dans l'éditeur et de l'afficher mis en forme. Rien n'est écrit dans votre projet.
Quelles versions d'Xcode fonctionnent ?
Toutes les versions d'Xcode qui prennent en charge les extensions Source Editor, sur macOS 14.0 et supérieur.
Puis-je lui attribuer un raccourci clavier ?
Oui, dans les réglages d'Xcode, rubrique Key Bindings, en cherchant le nom de l'extension. C'est Xcode qui gère le raccourci, pas l'extension.
Cela marche-t-il sur n'importe quel fichier Markdown, ou seulement sur README.md ?
Sur n'importe quel fichier Markdown ouvert dans l'éditeur, quel que soit son nom.
Cessez de lire votre documentation en source brute
Markdown Buddy est un achat unique à 5,99 €, sans abonnement ni achat intégré.
Télécharger sur le Mac App Store