Guida al Markdown

Il Markdown è un modo di scrivere testo formattato usando solo caratteri comuni. Questa pagina mostra tutto quello che Noblogs riconosce: a sinistra come si scrive, a destra come viene mostrato. Gli esempi non sono descritti a parole, sono resi dallo stesso programma che rende i tuoi articoli — quindi quello che vedi è esattamente quello che otterrai.

Paragrafi e ritorni a capo

Una riga vuota separa due paragrafi. Un Invio singolo, dentro lo stesso paragrafo, va a capo (come in un editor).

Come si scrive

Questo è un paragrafo: un a capo singolo
resta visibile, non si fonde in uno spazio.

Una riga vuota comincia un paragrafo nuovo.

Come viene mostrato

Questo è un paragrafo: un a capo singolo
resta visibile, non si fonde in uno spazio.

Una riga vuota comincia un paragrafo nuovo.

Titoli

Da uno a sei cancelletti. Ogni titolo riceve un identificatore ricavato dal testo, che serve per i collegamenti interni (#il-mio-titolo) e per la direttiva {{ indice }}. I titoli di primo e secondo livello si possono scrivere anche sottolineandoli.

Come si scrive

# Titolo principale

## Sezione

### Sottosezione

###### Sesto e ultimo livello

Come viene mostrato

Titolo principale

Sezione

Sottosezione

Sesto e ultimo livello

Come si scrive

Titolo sottolineato
===================

Sezione sottolineata
--------------------

Come viene mostrato

Titolo sottolineato

Sezione sottolineata

Corsivo, grassetto e compagnia

Il trattino basso in mezzo a una parola non crea corsivo, così i nomi come nome_della_variabile restano leggibili.

Come si scrive

*corsivo* oppure _corsivo_

**grassetto** oppure __grassetto__

***grassetto e corsivo insieme***

~~cancellato~~ e ==evidenziato==

H~2~O ha un pedice, il 6^o^ posto ha un apice.

`codice_inline()` non viene interpretato.

Un nome_con_trattini_bassi resta intatto.

Come viene mostrato

corsivo oppure corsivo

grassetto oppure grassetto

grassetto e corsivo insieme

cancellato e evidenziato

H2O ha un pedice, il 6o posto ha un apice.

codice_inline() non viene interpretato.

Un nome_con_trattini_bassi resta intatto.

Caratteri speciali e tipografia

Una barra rovesciata davanti a un carattere di punteggiatura lo rende letterale. Alcune sequenze diventano il simbolo corrispondente, e le virgolette diritte diventano curve.

Come si scrive

\*questo non è corsivo\* e \_nemmeno questo\_

(c) (r) (tm) +- ... -- ---

Le "virgolette doppie" e quelle 'singole' vengono curvate.

Le entità HTML come © → — passano intatte.

Come viene mostrato

*questo non è corsivo* e _nemmeno questo_

© ® ™ ± … – —

Le “virgolette doppie” e quelle ‘singole’ vengono curvate.

Le entità HTML come © → — passano intatte.

Elenchi

Puntati con -, * o +; numerati con "1." oppure "1)". Per annidare si indenta di due spazi. Cambiare simbolo comincia un elenco nuovo. Le caselle da spuntare si scrivono con [ ] e [x] e nella pagina non sono cliccabili.

Come si scrive

- primo elemento
- secondo elemento
  - annidato
  - un altro annidato
- terzo elemento

Come viene mostrato

  • primo elemento
  • secondo elemento
    • annidato
    • un altro annidato
  • terzo elemento

Come si scrive

1. primo passo
2. secondo passo
   1. dettaglio
3. terzo passo

5) si può anche partire da un altro numero
6) e continuare

Come viene mostrato

  1. primo passo
  2. secondo passo
    1. dettaglio
  3. terzo passo
  1. si può anche partire da un altro numero
  2. e continuare

Come si scrive

- [x] cosa già fatta
- [ ] cosa da fare

Come viene mostrato

  • cosa già fatta
  • cosa da fare

Citazioni e riquadri

Le citazioni possono contenere altri blocchi, elenchi compresi. Un riquadro si apre con [!NOTE], [!TIP], [!WARNING], [!DANGER] oppure [!INFO]; se non gli si dà un titolo, ne riceve uno predefinito.

Come si scrive

> Una citazione può continuare
> su più righe.
>
> E contenere più paragrafi.

Come viene mostrato

Una citazione può continuare
su più righe.

E contenere più paragrafi.

Come si scrive

> [!NOTE]
> Un riquadro con il titolo predefinito.

> [!WARNING] Attenzione ai link accorciati
> Il titolo del riquadro si può scrivere di seguito al tipo.

Come viene mostrato

Nota

Un riquadro con il titolo predefinito.

Attenzione ai link accorciati

Il titolo del riquadro si può scrivere di seguito al tipo.

Codice

I blocchi si delimitano con tre o più apici inversi (oppure tre tildi) e si può indicare il linguaggio, che diventa una classe CSS sul tag <code>. I blocchi indentati di quattro spazi non sono supportati: nella pratica nascono per sbaglio indentando un elenco.

Come si scrive

Il codice breve va fra apici inversi: `array_map()`.

```php
function saluta(string $nome): string
{
    return "Ciao $nome";
}
```

~~~
Un blocco senza linguaggio, delimitato da tildi.
~~~

Come viene mostrato

Il codice breve va fra apici inversi: array_map().

function saluta(string $nome): string
{
    return "Ciao $nome";
}
Un blocco senza linguaggio, delimitato da tildi.

Righe orizzontali

Tre o più trattini, asterischi o trattini bassi su una riga da soli. Attenzione: dei trattini subito sotto un paragrafo diventano un titolo sottolineato, non una riga.

Come si scrive

Primo blocco.

---

Secondo blocco.

***

Terzo blocco.

Come viene mostrato

Primo blocco.


Secondo blocco.


Terzo blocco.

Tabelle

La riga di separazione dichiara l'allineamento con i due punti. Le righe più corte o più lunghe dell'intestazione vengono pareggiate. Una barra verticale dentro una cella si scrive \|.

Come si scrive

| Voce      | Quantità | Stato    |
|:----------|---------:|:--------:|
| Articoli  |      128 | pubblici |
| Bozze     |        3 | private  |
| Pagine    |        7 | pubblici |

Come viene mostrato

Voce Quantità Stato
Articoli 128 pubblici
Bozze 3 private
Pagine 7 pubblici

Elenchi di definizioni

Il termine sulla prima riga, la definizione sulla riga successiva introdotta dai due punti. Un termine può avere più definizioni.

Come si scrive

Markdown
: Un modo di scrivere testo formattato usando solo caratteri comuni.

Direttiva
: Un segnaposto fra doppie graffe.
: Viene sostituito quando la pagina viene generata.

Come viene mostrato

Markdown
Un modo di scrivere testo formattato usando solo caratteri comuni.
Direttiva
Un segnaposto fra doppie graffe.
Viene sostituito quando la pagina viene generata.

Oltre alla forma normale ci sono i riferimenti, comodi quando lo stesso indirizzo ricorre più volte, e gli indirizzi automatici. Il prefisso tab: apre il collegamento in una scheda nuova. Gli schemi pericolosi (javascript:, data: fuori dalle immagini) vengono bloccati.

Come si scrive

[un collegamento](https://example.org)

[con un titolo](https://example.org "Compare passando il puntatore")

[a un altro tuo articolo](/il-mio-articolo/)

[in una scheda nuova](tab:https://example.org)

<https://example.org> e anche https://example.org da solo

<posta@example.org>

[con riferimento][esempio] e [un altro][esempio]

[esempio]: https://example.org "Titolo facoltativo"

Immagini

Come i collegamenti, ma con un punto esclamativo davanti. Il testo fra parentesi quadre è l'alternativa testuale: serve a chi usa uno screen reader e compare quando l'immagine non si carica — come negli esempi qui sotto, dove il file non esiste.

Come si scrive

![Una fotografia del mare](/media/mare.jpg)

![Con didascalia al passaggio](/media/mare.jpg "Liguria, 2024")

Come viene mostrato

Una fotografia del mare

Con didascalia al passaggio

Note a piè di pagina

Il rimando nel testo, la definizione dove capita: le note vengono raccolte e messe in fondo alla pagina, numerate nell'ordine in cui compaiono, con il collegamento per tornare al punto di partenza.

Come si scrive

Un'affermazione che ha bisogno di una fonte[^fonte], e una seconda nota[^altra].

[^fonte]: La fonte, con il suo indirizzo: <https://example.org>
[^altra]: Le note possono contenere più righe, se le righe successive
  sono indentate di due spazi.

Come viene mostrato

Un’affermazione che ha bisogno di una fonte1, e una seconda nota2.


  1. La fonte, con il suo indirizzo: https://example.org

  2. Le note possono contenere più righe, se le righe successive
    sono indentate di due spazi.

HTML scritto a mano

Si può usare HTML in mezzo al markdown, ma passa da una lista bianca: restano i tag di contenuto, spariscono script, style, i moduli e tutti i gestori di eventi, e gli iframe sono ammessi solo verso una lista di servizi noti. Gli esempi qui sotto sono resi con la bonifica attiva, come su qualsiasi blog.

Come si scrive

Il testo può contenere <abbr title="HyperText Markup Language">HTML</abbr> in linea, come <kbd>Ctrl</kbd>+<kbd>S</kbd>.

<figure>
<img src="/media/mare.jpg" alt="Una fotografia del mare">
<figcaption>Una didascalia sotto l'immagine.</figcaption>
</figure>

<details>
<summary>Un blocco che si apre e si chiude</summary>

Il contenuto nascosto, che può essere **markdown**.

</details>

Come viene mostrato

Il testo può contenere HTML in linea, come Ctrl+S.

Una fotografia del mare
Una didascalia sotto l'immagine.
Un blocco che si apre e si chiude

Il contenuto nascosto, che può essere markdown.

Come si scrive

<p onclick="alert(1)">Il gestore di eventi viene rimosso.</p>

<script>alert('questo sparisce del tutto')</script>

Come viene mostrato

Il gestore di eventi viene rimosso.

Direttive

Le direttive sono segnaposto fra doppie graffe che Noblogs sostituisce quando genera la pagina. Servono a inserire elementi che cambiano nel tempo — l'elenco dei tuoi articoli, la nuvola dei tag, il modulo di iscrizione — senza dover scrivere HTML.

Le direttive di blocco vanno scritte da sole nel loro paragrafo, con una riga vuota sopra e sotto: inseriscono un elenco o un modulo, che dentro un paragrafo non starebbe. Se le trovi in mezzo a una frase restano scritte come sono, così questa pagina può parlarne senza espanderle. Le direttive in linea inseriscono un valore e si possono usare dentro il testo.

Direttive di blocco

Direttiva Sinonimi Cosa inserisce
{{ posts }} post_list, elenco_post L'elenco dei tuoi articoli pubblicati, con la data e il titolo. Accetta i filtri elencati più sotto.
{{ tags }} tag_cloud, nuvola_tag L'elenco dei tag usati nei tuoi articoli, ognuno collegato all'elenco filtrato.
{{ toc }} indice L'indice dei titoli della pagina, annidato secondo i livelli.
{{ subscribe }} email_signup, iscrizione Il modulo di iscrizione agli aggiornamenti. Non produce nulla se le iscrizioni sono disattivate.
{{ search }} cerca Il modulo di ricerca interno al blog.
{{ archive }} archivio Tutti gli articoli raggruppati per anno.
{{ next_post }} post_successivo Il collegamento all'articolo successivo, se esiste.
{{ previous_post }} post_precedente Il collegamento all'articolo precedente, se esiste.
{{ post_nav }} Precedente e successivo affiancati, per il fondo di un articolo.

Direttive in linea

Direttiva Sinonimi Cosa inserisce
{{ blog_title }} titolo_blog Il titolo del blog.
{{ blog_description }} descrizione_blog La descrizione del blog, o le prime righe della homepage se non l'hai scritta.
{{ blog_link }} indirizzo_blog L'indirizzo del blog.
{{ blog_created }} blog_creato La data di creazione del blog.
{{ blog_last_posted }} ultimo_post Quanto tempo è passato dall'ultima pubblicazione, per esempio «3 giorni».
{{ post_count }} numero_post Il numero di articoli pubblicati.
{{ post_title }} titolo_post Il titolo dell'articolo corrente.
{{ post_description }} descrizione_post La descrizione dell'articolo corrente.
{{ post_link }} indirizzo_post L'indirizzo dell'articolo corrente.
{{ post_date }} data_post La data di pubblicazione dell'articolo corrente.
{{ post_updated }} post_aggiornato La data dell'ultima modifica dell'articolo corrente.
{{ year }} anno L'anno corrente, comodo per la riga del copyright nel piè di pagina.

Filtri

Alcune direttive accettano dei filtri, separati da una barra verticale e scritti come nome:valore. Si possono combinare: {{ posts|limit:5|tag:appunti|description:sì }}.

Filtro Cosa fa
{{ posts|limit:5 }} Quanti articoli mostrare, al massimo 200. Sinonimo: limite. Senza filtro sono 50.
{{ posts|order:asc }} Dal più vecchio al più recente. Sinonimo: ordine.
{{ posts|pages }} Include anche le pagine, non solo gli articoli. Sinonimo: pagine.
{{ posts|tag:appunti }} Solo gli articoli con quel tag; più tag separati da virgola, con il meno davanti per escluderli (tag:appunti,-privato).
{{ posts|from:2024-01-01|to:2024-12-31 }} Solo un intervallo di date. Sinonimi: da e a.
{{ posts|description:sì }} Aggiunge la descrizione sotto ogni titolo. Sinonimo: descrizione.
{{ posts|image:sì }} Aggiunge l'immagine dell'articolo, se ne ha una. Sinonimo: immagine.
{{ posts|date:no }} Toglie la data dall'elenco. Sinonimo: data.
{{ tags|limit:20 }} Quanti tag mostrare, al massimo 200.
{{ toc|depth:2 }} Fino a quale livello di titoli scendere, da 2 a 6. Sinonimo: profondita.

I nomi delle direttive e dei filtri esistono anche in italiano — {{ elenco_post }}, {{ nuvola_tag }}, {{ indice }}, |limite:5, |ordine:asc — e funzionano allo stesso modo. Una direttiva che non esiste resta scritta com'è nella pagina, senza errori: è il modo più semplice per accorgersi di un nome sbagliato.