Aggiunte convenzioni sui titoli Markdown
This commit is contained in:
@@ -188,10 +188,46 @@ Questo permette di distinguere chiaramente ciò che è ancora in discussione da
|
|||||||
|
|
||||||
## Convenzioni
|
## Convenzioni
|
||||||
|
|
||||||
|
### Convenzioni - Titoli Markdown
|
||||||
|
|
||||||
Ogni file Markdown deve contenere un solo titolo di primo livello (`#`), corrispondente al titolo del documento.
|
Ogni file Markdown deve contenere un solo titolo di primo livello (`#`), corrispondente al titolo del documento.
|
||||||
|
|
||||||
Le sezioni principali utilizzano titoli di secondo livello (`##`), mentre le sottosezioni utilizzano titoli di terzo livello (`###`).
|
Le sezioni principali utilizzano titoli di secondo livello (`##`), mentre le sottosezioni utilizzano titoli di terzo livello (`###`).
|
||||||
|
|
||||||
|
Ogni titolo deve essere univoco all'interno dello stesso file.
|
||||||
|
|
||||||
|
Nei documenti strutturati con sezioni ripetute, i titoli ricorrenti devono essere contestualizzati.
|
||||||
|
|
||||||
|
Esempio consigliato:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Titolo della campagna
|
||||||
|
|
||||||
|
### Titolo della campagna - Decisione
|
||||||
|
|
||||||
|
### Titolo della campagna - Motivazione
|
||||||
|
|
||||||
|
### Titolo della campagna - Conseguenze
|
||||||
|
```
|
||||||
|
|
||||||
|
Esempio da evitare:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Titolo della campagna
|
||||||
|
|
||||||
|
### Decisione
|
||||||
|
|
||||||
|
## Struttura della campagna
|
||||||
|
|
||||||
|
### Decisione
|
||||||
|
```
|
||||||
|
|
||||||
|
Questa convenzione evita errori dei linter Markdown e rende più chiari gli anchor link generati da Git, editor e visualizzatori Markdown.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Convenzioni - Struttura dei documenti
|
||||||
|
|
||||||
La struttura consigliata per ogni documento è la seguente:
|
La struttura consigliata per ogni documento è la seguente:
|
||||||
|
|
||||||
```markdown
|
```markdown
|
||||||
|
|||||||
Reference in New Issue
Block a user