Markdown Buddy › Anteprima Markdown in Xcode
Anteprima Markdown in Xcode
Xcode mostra i file Markdown come sorgente grezzo. Per un README, un CHANGELOG o una nota di architettura, questo significa leggere il markup invece del documento. Markdown Buddy include un'estensione Source Editor nativa: dal menu Editor, il file che stai consultando si apre renderizzato, senza uscire dal progetto.
Installare l'estensione
- Installa Markdown Buddy dal Mac App Store e avvialo una volta, così macOS registra l'estensione che contiene.
- Apri Impostazioni di Sistema, vai su Generali e poi su Elementi login ed estensioni, e attiva Markdown Buddy sotto Xcode Source Editor.
- Riavvia Xcode. Le estensioni vengono lette all'avvio, quindi un Xcode già aperto non vedrà quella appena attivata.
- Apri un file .md, poi usa Editor e quindi Markdown Buddy. Puoi assegnargli una scorciatoia da tastiera nelle impostazioni di Xcode, alla voce Key Bindings.
Perché conta su un repository
La documentazione di un progetto vive accanto al codice, ed è proprio l'editor di codice a mostrarla peggio:
- Un README con tabelle e badge è illeggibile come sorgente grezzo
- Un CHANGELOG è un lungo elenco annidato, dove l'indentazione porta il significato
- Una nota di architettura contiene spesso diagrammi Mermaid, che Xcode mostra come testo delimitato
- I link relativi tra documenti non si possono seguire dalla vista sorgente
Oltre l'estensione
La stessa app apre un'intera cartella come spazio di lavoro, cerca in tutti i suoi file .md e disegna il grafo dei collegamenti tra i tuoi documenti segnalando quelli non funzionanti. Su un repository con una documentazione cresciuta nel tempo, spesso è più utile dell'anteprima stessa.
Se il comando non compare nel menu Editor
- Verifica che l'estensione sia attiva in Impostazioni di Sistema, sezione Generali, Elementi login ed estensioni, voce Xcode Source Editor.
- Chiudi completamente Xcode e riavvialo. L'elenco delle estensioni viene letto solo all'avvio.
- Avvia Markdown Buddy una volta dalla cartella Applicazioni, poi riprova.
- Il comando compare solo se il documento in primo piano è un file Markdown. Su un file .swift resta nascosto.
Domande frequenti
Modifica il mio progetto?
No. L'estensione si limita a leggere il documento aperto nell'editor e a mostrarlo renderizzato. Nel progetto non viene scritto nulla.
Quali versioni di Xcode funzionano?
Tutte le versioni di Xcode che supportano le estensioni Source Editor, su macOS 14.0 e successivi.
Posso assegnargli una scorciatoia da tastiera?
Sì, nelle impostazioni di Xcode alla voce Key Bindings, cercando il nome dell'estensione. È Xcode a gestire la scorciatoia, non l'estensione.
Funziona con qualsiasi file Markdown o solo con README.md?
Con qualsiasi file Markdown aperto nell'editor, indipendentemente dal nome.
Smetti di leggere la documentazione come sorgente grezzo
Markdown Buddy è un acquisto unico da 5,99 €, senza abbonamento né acquisti in-app.
Scarica dal Mac App Store