Cosa rende PreviewMD, e cosa lo rende
Tutti i renderer elencati qui sotto viaggiano dentro l’app. Mentre un documento viene disegnato non si scarica nulla, nessuna CDN viene contattata, nessuna telemetria lascia il dispositivo: è per questo che Quick Look appare all’istante ed è per questo che tutto questo funziona anche in aereo.
Questa pagina è resa dallo stesso stack. Passa in alto a Sorgente e vedrai il Markdown dietro a ciascun esempio.
I moduli
| Modulo | Versione | Cosa fa |
|---|---|---|
| markdown-it | 14.1.0 | Il parser: CommonMark, più le estensioni di GitHub qui sotto |
| KaTeX | 0.16.22 | Matematica composta, non fotografata |
| Mermaid | 11.16.1 | Diagrammi disegnati dal testo |
| highlight.js | 11.11.1 | Evidenziazione della sintassi, quasi duecento linguaggi |
| @vscode/markdown-it-katex | 1.1.2 | Trova $…$ e $$…$$ nel testo e li passa a KaTeX |
| markdown-it-task-lists | 2.1.0 | Le caselle - [x] |
| markdown-it-footnote | 4.0.0 | Note a piè di pagina e i loro collegamenti indietro |
| markdown-it-emoji | 2.0.2 | Gli :shortcode: |
| markdown-it-front-matter | 0.2.4 | Front matter in YAML, nascosto invece che stampato |
| jsdiff + diff2html | — | La vista Diff e la sua evidenziazione per parola |
| github-markdown-css | — | Lo stile della pagina, chiaro e scuro |
Ognuno porta la propria nota di licenza, riprodotta alla lettera nell’app sotto Aiuto ▸ Ringraziamenti.
Matematica
KaTeX compone le formule, così si ingrandiscono, si selezionano e si copiano come testo invece di arrivare come un’immagine sfocata. La matematica in linea sta fra dollari singoli — la velocità in un punto qualsiasi di un’orbita è — e una formula su una riga propria sta fra dollari doppi:
Matrici, somme ed equazioni allineate funzionano allo stesso modo:
Diagrammi
Un blocco delimitato e marcato mermaid diventa un disegno. Il testo resta la fonte della verità: cambi una riga, cambia l’immagine, e il file è ancora un file di testo in cui il controllo di versione vede le differenze.
graph LR
A[Scrivi] --> B[Anteprima]
B --> C{Va bene?}
C -- sì --> D[Esporta]
C -- no --> A
Diagrammi di sequenza, per tutto ciò che ha un botta e risposta:
sequenceDiagram
participant F as Finder
participant Q as Quick Look
participant P as PreviewMD
F->>Q: barra spaziatrice su README.md
Q->>P: rendi questo file
P-->>Q: la pagina renderizzata
Q-->>F: mostrata, nessuna app avviata
E le proporzioni, dove una tabella ti lascerebbe i conti da fare:
pie showData
title Di cosa è fatto un README
"Prosa" : 55
"Blocchi di codice" : 30
"Tabelle" : 10
"Diagrammi" : 5
Diagrammi di stato e di classi, diagrammi di Gantt e il resto del repertorio di Mermaid si disegnano allo stesso modo.
Codice
I blocchi delimitati sono evidenziati da highlight.js, che conosce quasi duecento linguaggi. Il linguaggio si scrive subito dopo i delimitatori di apertura:
struct Entry: Comparable {
let clock: UInt64
let device: UUID
static func < (a: Entry, b: Entry) -> Bool {
// I pari merito si decidono sull'id del dispositivo, così l'ordine è lo stesso ovunque.
(a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
}
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
"""Delta-v totale per un trasferimento fra orbite circolari."""
first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
return first + second
Un blocco senza linguaggio resta testo a spaziatura fissa, e il codice in linea non ha bisogno di alcun linguaggio.
Le estensioni di GitHub
Ciò che GitHub ha aggiunto a Markdown, e che quindi un README dà per scontato:
- Elenchi di attività, con le caselle disegnate
- Comprese quelle ancora aperte
Barratoper ciò che non vale più- Note a piè di pagina[1], numerate e collegate indietro
- Collegamenti automatici: https://previewmd.xfanta.com diventa un link da sé
- Emoji tramite codice breve: 🚀 ✨ ✅
Note
I riquadri di avviso sono una convenzione di GitHub, non fanno parte di alcuna specifica di Markdown: una citazione la cui prima riga ne indica il tipo.
Warning
Sono cinque: Note, Tip, Important, Warning e Caution.
Che finiscono in fondo al documento, con una freccia che riporta al punto in cui stavi leggendo. ↩︎
I più discreti
Front matter. Un blocco YAML in cima al file, fra righe ---, sono metadati per un generatore di siti statici, non qualcosa che volevi leggere. Viene interpretato e nascosto, invece di essere stampato come una tabella di caratteri senza senso.
Immagini. Le immagini locali a cui un documento rimanda vengono mostrate, caricate dalla cartella in cui il documento si trova. Niente viene scaricato dalla rete, così un documento con un percorso sbagliato lo dice invece di restare appeso.
Tabelle. Normali tabelle GFM a barre verticali, con l’allineamento preso dai due punti nella riga di separazione. Quelle larghe scorrono invece di rompere la pagina.
Leggere tutto questo sul tuo Mac
PreviewMD rende tutto quello che c’è in questa pagina in Quick Look, nella sua finestra e nell’esportazione in HTML e PDF — su Mac, iPad e iPhone, gratis.
Il prontuario elenca ogni segno con il suo risultato, e cos’è Markdown racconta da dove viene il formato.