Cheat Sheet Markdown: i 21 elementi di sintassi in una pagina
Un cheat sheet markdown è un riferimento in una sola pagina che abbina ogni elemento markdown alla sua sintassi esatta, così puoi formattare un documento senza passare dalla documentazione completa. Questo riepilogo della sintassi markdown copre tutti i 21 elementi in due tabelle: i 10 elementi base che John Gruber definì nella specifica originale del 2004 e gli 11 elementi estesi che varianti successive come CommonMark (2014) e GitHub Flavored Markdown (2017) hanno aggiunto in seguito. Ogni esempio di sintassi in questa pagina funziona anche nell'editor markdown online, dove l'anteprima live ti mostra il risultato renderizzato mentre scrivi.
Sintassi base
La sintassi base comprende i 10 elementi del progetto markdown originale del 2004, e ogni applicazione markdown li renderizza in modo identico. Questi 10 elementi coprono il grosso della scrittura quotidiana: la struttura arriva da intestazioni ed elenchi, l'enfasi da grassetto e corsivo, i riferimenti da link e immagini. Se un documento usa solo le righe di questa tabella, viene renderizzato correttamente su GitHub, in Obsidian, su Reddit, in Discord e in qualsiasi editor creato dopo il 2004.
| Elemento | Syntax | Risultato renderizzato |
|---|---|---|
| Intestazione | # H1 / ## H2 / ### H3 | Titoli di sezione dai livelli 1 a 6; un # per livello |
| Grassetto | **strong words** | parole in grassetto |
| Corsivo | *slanted words* | parole in corsivo |
| Citazione | > quoted line | Blocco di citazione rientrato con un bordo a sinistra |
| Elenco ordinato | 1. Step one 2. Step two | Elenco numerato; la numerazione segue l'ordine |
| Elenco puntato | - First point - Second point | Elenco puntato; anche * e + funzionano come marcatori |
| Codice | `inline code` | codice inline in un riquadro monospace |
| Linea orizzontale | --- | Linea di separazione a tutta larghezza tra le sezioni |
| Link | [anchor text](https://example.com) | Collegamento cliccabile con etichetta "anchor text" |
| Immagine |  | Immagine incorporata con testo alternativo per l'accessibilità |
Il marcatore di intestazione richiede uno spazio dopo l'ultimo #, e la linea orizzontale richiede una riga vuota sopra di sé. Questi due dettagli causano la maggior parte degli errori di rendering della sintassi base.
Sintassi estesa
La sintassi estesa aggiunge 11 elementi che la specifica originale del 2004 non includeva, e il supporto dipende dalla variante markdown implementata da ogni applicazione. Tabelle, blocchi di codice delimitati ed elenchi di attività sono arrivati con GitHub Flavored Markdown, che GitHub ha formalizzato come specifica nel 2017. Note a piè di pagina, elenchi di definizioni ed evidenziazione provengono da altre varianti e vengono renderizzati in meno applicazioni.
| Elemento | Syntax | Risultato renderizzato |
|---|---|---|
| Tabella | | Name | Role | | --- | --- | | Ada | Engineer | | Griglia con riga di intestazione e colonne allineate |
| Blocco di codice delimitato | ```json { "id": 1 } ``` | Riquadro di codice su più righe con colorazione della sintassi opzionale |
| Nota a piè di pagina | A claim.[^1] [^1]: The source. | Riferimento numerato con nota in fondo alla pagina |
| ID di intestazione | ## Pricing {#pricing} | Intestazione con ancora personalizzata per link diretti |
| Elenco di definizioni | Term : Meaning of the term | Termine su una riga, definizione rientrata sotto |
| Barrato | ~~old figure~~ | |
| Elenco di attività | - [x] Ship the draft - [ ] Review edits | Checklist con caselle spuntate e non spuntate |
| Shortcode emoji | :tada: | Il carattere emoji corrispondente, 🎉 |
| Evidenziazione | ==key phrase== | Frase su sfondo colorato |
| Pedice | H~2~O | H₂O |
| Apice | x^2^ | x² |
Il supporto varia da applicazione ad applicazione: GitHub renderizza tabelle, blocchi di codice delimitati, elenchi di attività, barrato, note a piè di pagina e shortcode emoji ma ignora evidenziazione, pedice e apice; Obsidian gestisce tabelle, note a piè di pagina, elenchi di attività, barrato ed evidenziazione; Discord accetta grassetto, corsivo, barrato e blocchi di codice ma non supporta tabelle e note a piè di pagina. Quando la piattaforma di destinazione è sconosciuta, i 10 elementi base sono la scelta sicura.
Come usare questo cheat sheet
Trova l'elemento nella colonna di sinistra, copia la sintassi dalla colonna centrale e sostituisci il testo segnaposto con il tuo contenuto. La colonna del risultato renderizzato ti mostra come appare l'output, così puoi verificare che l'elemento corrisponda alla tua intenzione prima di copiarlo. Per tutto ciò che si trova nella tabella estesa, controlla prima la nota sul supporto: una nota a piè di pagina che viene renderizzata su GitHub scompare su Discord.
Il modo più rapido per verificare la sintassi è incollarla nell'editor markdown online. L'anteprima live renderizza ogni elemento in pochi millisecondi, quindi una tabella rotta o un marcatore ** non chiuso salta subito all'occhio. Chi usa markdown ogni giorno tende a memorizzare la tabella base entro una settimana; la tabella estesa è la parte che conviene tenere a portata di mano.
Scarica e stampa
Questo cheat sheet sta in una pagina A4 ed è disponibile come file .md, così puoi conservarne una copia nella tua app di note o stamparlo per la scrivania. Il file scaricato è a sua volta markdown valido, ed entrambe le tabelle vengono renderizzate correttamente in qualsiasi applicazione che supporti le tabelle GFM. Aprilo nell'editor, in Obsidian o in un repository GitHub e il riferimento resta formattato.
Domande frequenti
Qual è la differenza tra sintassi markdown base ed estesa?
Sintassi base significa i 10 elementi della specifica originale del 2004, mentre sintassi estesa significa gli 11 elementi aggiunti dalle varianti successive. Ogni applicazione markdown supporta il set base. Il set esteso dipende dalla variante: CommonMark ha standardizzato il comportamento di base nel 2014 e GFM ha aggiunto tabelle, elenchi di attività e barrato nella sua specifica del 2017.
Tutte le applicazioni markdown supportano la sintassi estesa?
No. Il supporto della sintassi estesa cambia da applicazione ad applicazione, e nessuna app renderizza tutti gli 11 elementi estesi. GitHub salta evidenziazione e pedice, Discord salta tabelle e note a piè di pagina, e Obsidian copre la gamma più ampia delle tre. I documenti destinati a più piattaforme dovrebbero affidarsi alla sintassi base più le tabelle GFM.
Markdown è difficile da imparare?
No. Markdown ha 21 elementi in totale, e i 10 elementi base coprono la maggior parte dei documenti. Un # per le intestazioni, ** per il grassetto e - per gli elenchi coprono la maggioranza dell'uso reale. La maggior parte delle persone scrive markdown con scioltezza dopo una sola sessione con un editor ad anteprima live, perché l'anteprima corregge gli errori sul momento.