Markdown è un linguaggio di markup leggero, creato per rendere la scrittura di testo formattato semplice e veloce. È ideale per chi vuole concentrarsi sui contenuti, senza preoccuparsi della complessità dell’HTML. Usato ampiamente su GitHub, nei blog, nelle wiki e nelle app di note, Markdown ti aiuta a creare documenti chiari, ordinati e facilmente leggibili.
Markdown nasce per semplificare la formattazione del testo. Con pochi simboli puoi aggiungere titoli, elenchi, link, immagini e molto altro. Si usa principalmente in:
Markdown si distingue per la sua leggibilità: il testo rimane comprensibile anche senza essere convertito in HTML.
I titoli si creano con il simbolo # (da uno a sei, in base al livello):
# Titolo principale (livello 1)
## Titolo secondario (livello 2)
### Sottotitolo (livello 3)
#### Livello 4
##### Livello 5
###### Livello 6
**testo** o __testo__*testo* o _testo_~~testo~~***testo***Esempio:
Questo è **grassetto**, questo è *corsivo*, questo è ~~barrato~~, questo è ***grassetto e corsivo***.
Per separare i paragrafi, lascia una riga vuota tra di loro.
Usa -, * o + per creare elenchi non ordinati:
- Elemento uno
- Elemento due
- Sotto-elemento
- Sotto-sotto-elemento
Basta mettere il numero seguito da un punto:
1. Primo
2. Secondo
3. Terzo
Su GitHub puoi creare checklist interattive:
- [x] Compito completato
- [ ] Compito da fare
Crea un collegamento con:
[Descrizione](https://www.sito.com)
Puoi anche aggiungere un titolo visibile al passaggio del mouse:
[GitHub](https://github.com "Vai su GitHub")
Simile ai link, ma con un punto esclamativo davanti:
Il testo alternativo è importante per l’accessibilità e viene mostrato se l’immagine non si carica.
Usa il simbolo >:
> Questo è un blocco di citazione.
>> Citazione annidata.
Per evidenziare una parola o una riga di codice, usa il backtick:
`print("Ciao mondo")`
Per blocchi di codice (multi-riga), usa tre backtick:
```python
def funzione():
return "Ciao"
```.
(non considerare il punto finale)
Puoi specificare il linguaggio per la colorazione della sintassi.
Le tabelle si creano con il simbolo | e trattini:
| Nome | Cognome | Età |
|----------|-----------|-----|
| Mario | Rossi | 30 |
| Anna | Bianchi | 27 |
Puoi allineare il testo nelle colonne:
| Sinistra | Centro | Destra |
|:---------|:--------:|--------:|
| uno | due | tre |
Usa tre trattini o tre asterischi:
---
oppure
***
Markdown permette di combinare elenchi, citazioni e altri elementi per strutturare il testo in modo efficace:
- Elemento principale
- Sotto-elemento
> Citazione relativa
Se vuoi mostrare simboli che normalmente sono usati per la sintassi, anteponi una barra invertita \:
\*Questo non è corsivo\*
\# Questo non è un titolo
Su GitHub puoi menzionare persone e fare riferimento a issue e pull request:
Grazie @AlexMaina05! Consulta la discussione #42 per dettagli.
Usa le emoji scrivendo il nome tra due punti:
:smile: :rocket: :fire:
Per evidenziare avvisi e note importanti:
> **Attenzione**
> Questo è un messaggio importante per gli utenti.
# Nome Progetto
Descrizione breve del progetto.
## Installazione
```sh
git clone https://github.com/username/repo.git
cd repo
from modulo import funzione
funzione()
- [x] Forka il repo
- [x] Fai una pull request
Ecco alcuni link utili per approfondire:
Markdown è uno strumento fondamentale per chi vuole scrivere contenuti chiari, ordinati e facili da gestire, che siano documentazione tecnica, guide, note o articoli. Imparare Markdown ti renderà più produttivo su GitHub, nei blog, nelle wiki e ovunque serva struttura e leggibilità.
Sperimenta, combina le varie funzionalità e crea documenti utili per te e per la comunità.
Buona scrittura con Markdown! 🚀