Come aggiungere una checkbox in Markdown:sintassi delle liste di attività ed esempi.

Sintassi delle liste di attività in Markdown

Una lista di attività è un normale elenco le cui voci iniziano con un marcatore di casella. La ricetta ha tre parti:

1. Un marcatore di elenco

   Un trattino, un asterisco o un più, seguito da uno spazio: -. Funziona anche una voce numerata come 1..

2. Una casella tra parentesi quadre

   [ ] con uno spazio all'interno è una casella vuota. [x] è una spuntata; vale anche la maiuscola [X]. Tra le parentesi non va nient'altro.

3. Uno spazio, poi il testo

   Senza lo spazio dopo ] la riga resta testo semplice con le parentesi dentro.

- [x] Draft the spec
- [x] Add the edge cases
- [ ] Get a review
- [ ] Hand it to the agent

Ecco cosa vede chi legge:

• Scrivere la specifica
• Aggiungere i casi limite
• Ottenere una revisione
• Passarla all'agente

Checkbox annidate

Rientra un'attività sotto un'altra per creare una sotto-attività. Due spazi bastano nella maggior parte dei renderer; quattro sono la scelta più sicura:

- [ ] Release 2.0
    - [x] Update the changelog
    - [ ] Tag the build
    - [ ] Announce it
- [ ] Plan 2.1

Puoi mescolare attività e normali punti elenco nella stessa lista, e mettere un paragrafo, del codice o una citazione sotto un'attività rientrandolo in linea con il testo dell'attività. La casella genitore non si spunta da sola quando i figli sono completati: la spunti tu.

Dove vengono mostrate le checkbox Markdown

• GitHub mostra le liste di attività come caselle nei file Markdown, nelle issue, nelle pull request e nei commenti. In una issue o in una pull request puoi spuntare una casella nella pagina e GitHub modifica il testo per te.
• Le app Markdown che seguono GFM le mostrano a loro volta. In DotMD appaiono come caselle nel lettore. Lì le caselle sono di sola lettura: per spuntarne una, modifica la riga e cambia [ ] in [x].
• I parser minimali che conoscono solo il Markdown originale o CommonMark mostrano il testo così com'è, con le parentesi. Si legge comunque come una lista di cose da fare, solo senza caselle.

Se usi DotMD Editor, premendo Enter alla fine di un'attività parte la successiva con un - [ ] vuoto, così puoi continuare a scrivere voci.

Un segno di spunta in Markdown senza lista di attività

Quando vuoi una spunta in una tabella o in una frase, non in un elenco, scrivi direttamente il carattere. I simboli Unicode sono testo, quindi compaiono in ogni app Markdown:

GitHub accetta anche gli shortcode delle emoji come :white_check_mark:. Sono una funzione di GitHub: in un'altra app possono comparire come testo grezzo, quindi preferisci il carattere se il file sarà letto altrove.

Liste di attività in piani e specifiche

Le liste di attività non servono solo alle app di to-do. Un piano o una specifica scritti in Markdown spesso finiscono con una checklist di ciò che resta da fare, e ogni passaggio è facile da rivedere sulla sua riga:

## Tasks
- [x] Add the settings screen
- [ ] Write the migration
- [ ] Update the tests
- [ ] Update the docs

Tieni ogni attività a una sola azione che si possa finire e verificare. Usa un titolo per ogni gruppo e annida le sotto-attività solo quando appartengono a un unico genitore.

Perché una lista di attività mostra le parentesi invece delle caselle

• Nessuno spazio dopo la parentesi: - [x]Fatto non è un'attività. Scrivi - [x] Fatto.
• Spazi dentro le parentesi: [ ] con due spazi, o [ x ], è testo semplice.
• Nessun marcatore di elenco: una riga che inizia solo con [ ] non è una voce di elenco.
• Testo che inizia con una parentesi. La documentazione di GitHub dice di fare l'escape della parentesi: scrivi - [ ] \(Facoltativo) Provalo.
• Il renderer non supporta GFM. Allora vedi le parentesi, qualunque cosa scrivi.

Per controllare come appare un piano con attività, apri il file in DotMD, dove la lettura è gratuita. Specifiche e piani sono spesso scritti come liste di attività, e le caselle rendono facile scorrerne una lunga.

Domande sulle checkbox Markdown

Altre domande