Markdown Preview
Live Markdown preview
Live Markdown preview Funziona localmente nel tuo browser
About the
L'anteprima Markdown esegue il rendering del tuo Markdown durante la digitazione, in una visualizzazione affiancata, seguendo CommonMark con le estensioni GitHub che la maggior parte delle persone utilizza effettivamente: tabelle, elenchi di attività, blocchi di codice protetti, barrato e collegamenti automatici. È il modo più rapido per controllare un README prima di eseguirne il commit, perché le differenze tra l'aspetto di Markdown nell'origine e quello nel rendering non sono evidenti e la sintassi della tabella in particolare fallisce silenziosamente quando una singola pipe o un trattino sono errati. L'HTML renderizzato può anche essere copiato se ne hai bisogno da qualche parte che non elabori Markdown stesso.
Where people use the
- Controllare il rendering corretto di un file README prima di inviarlo.
- Redazione di note di rilascio o di un registro delle modifiche con una visualizzazione in tempo reale del risultato.
- Conversione di un documento Markdown in HTML per un CMS che non accetta Markdown.
- Esaminare la richiesta pull Markdown di qualcun altro e vedere come apparirà.
How to use the
- 1
Incolla o scrivi il tuo Markdown
L'editor accetta qualsiasi cosa, da un singolo paragrafo a un documento completo con intestazioni, elenchi, collegamenti e recinzioni di codice.
- 2
Guarda il pannello renderizzato
L'anteprima si aggiorna a ogni pressione di un tasto, quindi una tabella rotta o un recinto non chiuso vengono visualizzati immediatamente anziché dopo una fase di pubblicazione.
- 3
Correggi la fonte, non l'anteprima
L'anteprima è di sola lettura. Quando qualcosa viene visualizzato in modo errato, la causa è quasi sempre la mancanza di una riga vuota prima di un elenco o di un'intestazione di tabella senza riga delimitatrice.
- 4
Copia l'HTML se ne hai bisogno
Passa alla visualizzazione HTML per prendere il markup generato, utile per incollarlo in un CMS che prevede HTML anziché Markdown.
Suggerimenti e migliori pratiche
- Lascia una riga vuota prima e dopo ogni elemento del blocco; i bug di rendering più misteriosi sono una riga vuota mancante.
- Utilizza blocchi di codice protetti con un nome di lingua in modo che il codice venga evidenziato anziché trattato come testo normale.
- Mantieni una frase per riga nei documenti lunghi; rende le differenze leggibili in seguito.
Domande frequenti
Quale specifica Markdown viene utilizzata?
CommonMark come base, oltre alle estensioni GitHub Flavored Markdown per tabelle, elenchi di attività, codice delimitato e barrato. Questa combinazione copre il formato README su GitHub, GitLab e la maggior parte dei siti di documentazione.
Perché la mia tabella non viene renderizzata?
Una tabella necessita di una riga di intestazione seguita immediatamente da una riga delimitatrice di trattini, con una riga vuota prima del blocco. Ogni riga deve avere lo stesso numero di tubi dell'intestazione. Uno qualunque di quelli mancanti trasforma il tutto in un paragrafo di testo con caratteri pipe al suo interno.
Perché gli elementi del mio elenco si sono uniti in un unico paragrafo?
Markdown necessita di una riga vuota tra un paragrafo e un elenco che lo segue. Senza di esso, i marcatori dell'elenco vengono trattati come testo normale.
Supporta LaTeX o la matematica?
No. Il rendering matematico necessita di una libreria separata come KaTeX o MathJax e di una sintassi diversa. Un'espressione con il simbolo del dollaro qui verrà visualizzata come testo semplice.
È consentito l'HTML grezzo?
Sì, l'HTML in linea passa direttamente, che è ciò che fa anche GitHub. Se pubblichi l'output in un luogo pubblico, disinfettalo prima, perché l'HTML grezzo è anche il modo in cui vengono inseriti gli script.
Dove va il mio testo?
Luogo inesistente. L'analisi e il rendering avvengono nel tuo browser con una libreria JavaScript Markdown. Niente viene salvato o trasmesso, quindi la bozza scompare quando chiudi la scheda a meno che non la copi.