Come usare l'editor Markdown
- Scrivi o incolla il Markdown nell'editor a sinistra.
- Guarda l'anteprima in tempo reale che si aggiorna mentre scrivi, con il rendering del Markdown in stile GitHub (GFM).
- Fai clic su Copia HTML per copiare l'HTML generato da usare in un sito web, in un CMS o in un'email.
- Oppure copia il Markdown stesso per un README, una issue, una pull request o una pagina di documentazione.
Il rendering avviene nel tuo browser e il tuo testo non viene caricato né memorizzato. L'HTML generato viene ripulito, quindi script e attributi pericolosi nel contenuto incollato vengono rimossi prima di mostrare l'anteprima.
Che cos'è il Markdown?
Il Markdown è un linguaggio di markup leggero creato da John Gruber nel 2004. Usa la punteggiatura del testo semplice per la formattazione: # per i titoli, * o _ per l'enfasi, - per gli elenchi. Il sorgente resta leggibile come testo semplice e un renderer lo trasforma in HTML.
La descrizione originale lasciava indefiniti molti casi limite, quindi le implementazioni divergevano. CommonMark è una specifica dettagliata che risolve queste ambiguità, e il Markdown in stile GitHub è un sovrainsieme di CommonMark che aggiunge funzioni che gli sviluppatori usano ogni giorno:
| Funzione GFM | Sintassi |
|---|---|
| Tabelle | | Name | Value | con una riga di separazione |---|---| |
| Elenchi di attività | - [ ] todo e - [x] done |
| Testo barrato | ~~removed~~ |
| Collegamenti automatici | Gli URL isolati come https://example.com diventano link |
| Blocchi di codice delimitati | Tre apici inversi, seguiti facoltativamente dal nome di un linguaggio |
Guida rapida al Markdown
# Heading 1
## Heading 2
**bold**, *italic*, `inline code`
- Bullet item
- Nested item (indent two spaces)
1. Numbered item
[Link text](https://example.com)
> A blockquote
```python
print("fenced code with a language")
```Problemi comuni del Markdown e come risolverli
Titolo che non viene reso. CommonMark richiede uno spazio dopo i cancelletti. #Title è testo semplice; # Title è un titolo.
Righe unite in un solo paragrafo. Un singolo a capo dentro un paragrafo viene trattato come uno spazio. Lascia una riga vuota per iniziare un nuovo paragrafo, oppure termina una riga con due spazi o una barra rovesciata per un a capo forzato. (I commenti di GitHub trattano i singoli a capo in modo diverso dai file README, ed è una frequente fonte di confusione.)
Elenco o blocco di codice che si interrompe prima del dovuto. Il contenuto che appartiene a una voce di elenco deve essere indentato in modo da allinearsi al testo della voce. Per il codice dentro un elenco, indenta l'intero blocco delimitato:
1. Install the package:
```bash
npm install example
```
2. Run it.Tabella che non viene resa. Una tabella GFM richiede una riga di intestazione, una riga di separazione con almeno tre trattini per colonna e di solito una riga vuota prima. Usa i due punti nel separatore (:---, :---:, ---:) per allineare le colonne.
Formattazione indesiderata. Caratteri come *, _ e # possono attivare la formattazione. Anteponi una barra rovesciata, per esempio \*not italic\*, oppure racchiudili tra apici inversi.
Consigli e buone pratiche
- Aggiungi sempre un linguaggio dopo gli apici inversi di apertura, così i blocchi di codice ottengono l'evidenziazione della sintassi dove è supportata.
- Scrivi un testo alternativo significativo per le immagini; è usato dagli screen reader e mostrato quando l'immagine non si carica.
- Usa una frase per riga nei documenti lunghi; il Markdown le unisce in paragrafi e i diff diventano molto più puliti.
- Incolla prima gli esempi JSON o YAML nel Formattatore e validatore JSON o nel Formattatore e validatore YAML, così i blocchi di codice della tua documentazione sono validi e ordinati.
- Se incolli l'HTML generato in una pagina web, passalo nel Formattatore HTML per indentarlo in modo ordinato.
Domande frequenti
Qual è la differenza tra Markdown e Markdown in stile GitHub?
GFM è un sovrainsieme del Markdown CommonMark definito da GitHub. Aggiunge tabelle, elenchi di attività, testo barrato, collegamenti automatici estesi e alcune restrizioni sull'HTML grezzo. La maggior parte dei README scritti per GitHub qui viene resa allo stesso modo.
Posso usare HTML dentro il Markdown?
Sì, il Markdown ammette HTML in linea. Per sicurezza l'anteprima ripulisce l'output, quindi tag come <script>, attributi di gestione eventi come onclick e link javascript: vengono rimossi.
Perché il mio Markdown appare diverso su un altro sito?
Le piattaforme usano varianti diverse di Markdown e fogli di stile propri. La sintassi di base (titoli, enfasi, elenchi, link, codice) è coerente, ma tabelle, a capo ed estensioni come note a piè di pagina o formule variano da un renderer all'altro.
Come converto il Markdown in HTML?
Scrivi o incolla il tuo Markdown, controlla l'anteprima, poi fai clic su Copia HTML. L'output è HTML semantico semplice (titoli, paragrafi, elenchi, tabelle) senza stili, quindi acquisisce il CSS della pagina in cui lo incolli.
Aggiornato