Markdown Buddy › Markdown-Vorschau in Xcode
Markdown-Vorschau in Xcode
Xcode zeigt Markdown-Dateien als reinen Quelltext. Bei einer README, einem CHANGELOG oder einer Architekturnotiz heißt das: Sie lesen die Auszeichnung statt des Dokuments. Markdown Buddy bringt eine native Source-Editor-Erweiterung mit. Aus dem Editor-Menü öffnet sich die Datei, die Sie gerade ansehen, gerendert, ohne dass Sie Ihr Projekt verlassen.
Die Erweiterung installieren
- Installieren Sie Markdown Buddy aus dem Mac App Store und starten Sie die App einmal, damit macOS die mitgelieferte Erweiterung registriert.
- Öffnen Sie die Systemeinstellungen, gehen Sie zu Allgemein und dann zu Anmeldeobjekte und Erweiterungen, und aktivieren Sie Markdown Buddy unter Xcode Source Editor.
- Starten Sie Xcode neu. Erweiterungen werden beim Start gelesen, ein bereits laufendes Xcode sieht eine gerade aktivierte also nicht.
- Öffnen Sie eine .md-Datei und wählen Sie Editor, dann Markdown Buddy. In den Xcode-Einstellungen unter Key Bindings können Sie einen Kurzbefehl vergeben.
Warum das bei einem Repository zählt
Die Projektdokumentation liegt neben dem Code, und ausgerechnet der Code-Editor zeigt sie am schlechtesten:
- Eine README mit Tabellen und Badges ist als roher Quelltext unlesbar
- Ein CHANGELOG ist eine lange verschachtelte Liste, in der die Einrückung die Bedeutung trägt
- Eine Architekturnotiz enthält oft Mermaid-Diagramme, die Xcode als abgegrenzten Text darstellt
- Relative Links zwischen Dokumenten lassen sich aus der Quelltextansicht nicht verfolgen
Über die Erweiterung hinaus
Dieselbe App öffnet einen ganzen Ordner als Arbeitsbereich, durchsucht darin jede .md-Datei und zeichnet den Graphen der Verknüpfungen zwischen Ihren Dokumenten, wobei defekte Links markiert werden. Bei einem Repository mit gewachsener Dokumentation ist das oft nützlicher als die Vorschau selbst.
Wenn der Befehl nicht im Editor-Menü erscheint
- Prüfen Sie, dass die Erweiterung in den Systemeinstellungen unter Allgemein, Anmeldeobjekte und Erweiterungen, Abschnitt Xcode Source Editor, aktiviert ist.
- Beenden Sie Xcode vollständig und starten Sie es neu. Die Liste der Erweiterungen wird nur beim Start gelesen.
- Starten Sie Markdown Buddy einmal aus dem Ordner Programme und versuchen Sie es erneut.
- Der Befehl erscheint nur, wenn das vorderste Dokument eine Markdown-Datei ist. Bei einer .swift-Datei bleibt er ausgeblendet.
Häufige Fragen
Verändert das mein Projekt?
Nein. Die Erweiterung liest lediglich das im Editor geöffnete Dokument und zeigt es gerendert an. In Ihr Projekt wird nichts geschrieben.
Welche Xcode-Versionen funktionieren?
Alle Xcode-Versionen, die Source-Editor-Erweiterungen unterstützen, unter macOS 14.0 und neuer.
Kann ich einen Tastaturkurzbefehl vergeben?
Ja, in den Xcode-Einstellungen unter Key Bindings, indem Sie nach dem Namen der Erweiterung suchen. Den Kurzbefehl verwaltet Xcode, nicht die Erweiterung.
Funktioniert das mit jeder Markdown-Datei oder nur mit README.md?
Mit jeder im Editor geöffneten Markdown-Datei, unabhängig vom Namen.
Lesen Sie Ihre Dokumentation nicht länger als Quelltext
Markdown Buddy ist ein einmaliger Kauf für 5,99 €, ohne Abo und ohne In-App-Kauf.
Im Mac App Store laden