Ogni elemento Markdown con un esempio che puoi modificare e vedere subito renderizzato: a capo, link, tabelle, checkbox, note a piè di pagina, blocchi di codice e alert di GitHub, più un template per il README.
Markdown formatta il testo semplice con pochi simboli: # per i titoli, **due asterischi** per il grassetto, [testo](indirizzo) per i link, - per gli elenchi puntati e tre backtick per i blocchi di codice. Ogni esempio qui sotto si può modificare e l'anteprima accanto si aggiorna mentre scrivi, così puoi provare una sintassi prima di usarla.
I cinque che userai di più
Diciotto esempi live che coprono tutto, dai titoli alle note a piè di pagina e agli alert di GitHub, una tabella delle differenze tra GitHub e il CommonMark standard, un template per il README e un editor completo in fondo alla pagina.
Termina la riga con due spazi o un backslash, poi premi Invio. Un Invio semplice viene trattato come uno spazio e le righe si uniscono. Per un nuovo paragrafo invece di un semplice a capo, lascia una riga vuota.
Inizia una voce di elenco con - [ ] per una casella vuota o - [x] per una spuntata. Le task list fanno parte di GitHub Flavored Markdown, quindi funzionano su GitHub, GitLab e nella maggior parte delle app per appunti, ma non nel CommonMark rigoroso.
Scrivi la riga di intestazione con delle barre verticali tra le colonne, poi una riga di trattini, poi una riga per ogni riga della tabella. Nel sorgente le colonne non devono essere allineate. Aggiungi i due punti alla riga dei trattini per allineare una colonna a sinistra, a destra o al centro.
Markdown è la sintassi originale del 2004, che lasciava molti casi non definiti. CommonMark è una specifica precisa di quella sintassi di base. GitHub Flavored Markdown è CommonMark più tabelle, task list, barrato, link automatici e note a piè di pagina, ed è ciò che segue la maggior parte degli strumenti per sviluppatori.
La maggior parte dei renderer lo consente, per questo i tag details e summary o un'immagine centrata sono comuni nei README. GitHub rimuove script, stili e alcuni attributi per sicurezza. Le anteprime di questa pagina non renderizzano l'HTML grezzo, quindi lo mostrano come testo.
Da uno a sei simboli #, poi uno spazio. Usa un solo titolo con # per documento.
Funzionano anche i trattini bassi (__bold__, _italic_), ma non a metà di una parola.
Due tilde per lato. Fa parte di GitHub Flavored Markdown, non del CommonMark di base.
Un singolo Invio non spezza la riga. Terminala con due spazi o un backslash, oppure lascia una riga vuota per un nuovo paragrafo.
Il testo tra parentesi quadre, l'indirizzo tra parentesi tonde. Le parentesi angolari rendono cliccabile un indirizzo nudo.
Tiene gli indirizzi lunghi fuori dal testo. Le definizioni possono stare ovunque e non vengono mostrate.
Come un link con ! davanti. Il testo tra parentesi è il testo alternativo che leggono gli screen reader.
Usa -, * o + per i punti elenco e 1. per i numeri. Rientra di due-quattro spazi per annidare.
Uno spazio tra le parentesi significa non spuntata; una x significa spuntata. Su GitHub puoi spuntarle nelle issue.
Inizia ogni riga con >. Una riga con solo > mantiene i paragrafi in un'unica citazione.
I backtick mantengono il testo esattamente come scritto. Per mostrare un backtick, racchiudilo tra due: `` a`b ``.
Tre backtick prima e dopo. La parola dopo l'apertura indica il linguaggio per l'evidenziazione.
Le barre verticali separano le colonne; la riga di trattini è obbligatoria. I due punti impostano l'allineamento: sinistra, destra o centro.
Tre o più trattini, asterischi o trattini bassi su una riga a sé. Lascia righe vuote attorno ai trattini perché non vengano letti come sottolineatura di un titolo.
La nota viene raccolta in fondo al documento con un link di ritorno.
Un backslash prima di * _ # [ ] ` e caratteri simili li mostra come testo semplice.
GitHub trasforma gli indirizzi semplici in link. Il CommonMark rigoroso richiede le parentesi angolari.
GitHub li mostra come riquadri colorati; le altre app mostrano una citazione semplice, come fa l'anteprima qui.
Sintassi Markdown e dove funziona
Dove GitHub Flavored Markdown differisce da CommonMark
Ovunque
GitHub e la maggior parte delle app
Solo GitHub
Markdown (modificami)
Anteprima
Copia
Ripristina
La sintassi in breve
Ogni elemento, live
GitHub vs CommonMark
Template per il README
Copia il template
Apri nell'editor
Editor completo
Markdown
Copia il Markdown
{n} parole. Niente viene salvato o inviato.
Inizia gratis · Nessuna carta di credito richiesta