Markdown Docs — Cheat Sheet
Tag: markdown, docs, documentation, gfm, syntax
Livello: base
TL;DR: Sintassi e concetti fondamentali per scrivere documentazione in Markdown in modo rapido, efficace e leggibile.
Concetti chiave
Markdown è un linguaggio di markup leggero con formattazione in testo semplice.
L'obiettivo principale è essere facile da leggere e da scrivere, senza tag complessi.
GitHub-Flavored Markdown (GFM) aggiunge funzionalita' come tabelle, task list e autolink.
Supporta codice inline e blocchi di codice con evidenziazione della sintassi.
Permette di nidificare facilmente elenchi puntati, numerati e citazioni.
Può contenere tag HTML per formattazioni avanzate, se il parser lo permette.
Ideale per file README, wiki, changelog e documentazione tecnica nei repository.
Domande tipiche e risposte pronte
Q: Come si crea un blocco di codice con l'evidenziazione della sintassi?R: Uso tre backtick seguiti dal nome del linguaggio, inserisco il codice e chiudo con tre backtick.
Q: Come si inserisce un'immagine in Markdown?R: Uso un punto esclamativo, seguito da parentesi quadre per l'alt-text e parentesi tonde per il path o URL.
Q: Qual è la differenza tra elenchi numerati e non in fase di rendering?R: Anche se scrivo sempre "1." su ogni riga, il parser li numera automaticamente in ordine sequenziale corretto.
Insidie e errori comuni
Dimenticare lo spazio dopo il cancelletto per definire gli header.
Non lasciare una riga vuota per separare un blocco di testo da un elenco.
Sbagliare l'indentazione (generalmente servono 2 o 4 spazi) per creare elenchi nidificati.
Usare apici singoli al posto dei backtick per formattare il codice inline.
Mancanza di una riga vuota tra blocchi di testo, impedendo la creazione di nuovi paragrafi.
Snippet e comandi
# Titolo 1
## Titolo 2
Testo **grassetto**, *corsivo* e ~~barrato~~.
- [ ] Task non completato
- [x] Task completato
[Testo del link](https://esempio.com)
> Questo è un blockquote
> su più righe.
| Header 1 | Header 2 |
|:---------|:--------:|
| Sinistra | Centro |Da ripassare
[ ] Allineamento specifico delle colonne nelle tabelle GFM
[ ] Integrazione di diagrammi Mermaid all'interno dei parser compatibili
[ ] Uso dei reference link per mantenere pulito il testo nei documenti lunghi
