Jak přidat zaškrtávací políčko v Markdownu:syntaxe úkolového seznamu a příklady.

Syntaxe úkolového seznamu v Markdownu

Úkolový seznam je obyčejný seznam, jehož položky začínají značkou políčka. Recept má tři části:

1. Značka seznamu

   Pomlčka, hvězdička nebo plus a mezera: -. Funguje i číslovaná položka jako 1..

2. Políčko v hranatých závorkách

   [ ] s jednou mezerou uvnitř je prázdné políčko. [x] je zaškrtnuté; počítá se i velké [X]. Nic jiného mezi závorky nepatří.

3. Mezera a text

   Bez mezery za ] zůstane řádek obyčejným textem se závorkami.

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

Takhle to vidí čtenář:

• Načrtnout specifikaci
• Přidat okrajové případy
• Získat revizi
• Předat agentovi

Vnořená zaškrtávací políčka

Úkol odsazený pod jiným úkolem je podúkol. Ve většině rendererů stačí dvě mezery, čtyři jsou nejjistější:

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

V jednom seznamu můžete míchat úkoly s obyčejnými odrážkami a pod úkol dát odstavec, kód nebo citaci, když je odsadíte k textu úkolu. Nadřazené políčko se samo nezaškrtne, když jsou hotové podúkoly; zaškrtnete ho vy.

Kde se zaškrtávací políčka v Markdownu vykreslí

• GitHub zobrazuje úkolové seznamy jako políčka v souborech Markdown, issues, pull requestech a komentářích. V issue nebo pull requestu můžete políčko zaškrtnout přímo na stránce a GitHub upraví text za vás.
• Aplikace pro Markdown, které sledují GFM, je zobrazují také. V DotMD se v čtečce objeví jako políčka. Jsou tam jen pro čtení: chcete-li jedno zaškrtnout, upravte řádek a změňte [ ] na [x].
• Minimální parsery, které znají jen původní Markdown nebo CommonMark, ukážou text tak, jak je, se závorkami. Pořád se čte jako seznam úkolů, jen ne jako políčka.

Pokud používáte DotMD Editor, stisknutí Enter na konci úkolu začne další prázdným - [ ], takže můžete psát další položky.

Zatržítko v Markdownu bez úkolového seznamu

Když chcete zatržítko v tabulce nebo ve větě, ne v seznamu, napište samotný znak. Symboly Unicode jsou text, takže se zobrazí v každé aplikaci pro Markdown:

GitHub přijímá i zkratky emoji, například :white_check_mark:. Je to funkce GitHubu: v jiné aplikaci se mohou zobrazit jako holý text, takže pokud se soubor bude číst jinde, dejte přednost samotnému znaku.

Úkolové seznamy v plánech a specifikacích

Úkolové seznamy nejsou jen pro aplikace na úkoly. Plán nebo specifikace v Markdownu často končí seznamem toho, co zbývá udělat, a každý krok se dá zkontrolovat na vlastním řádku:

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

Každý úkol ať je jedna akce, kterou lze dokončit a ověřit. Pro každou skupinu použijte nadpis a podúkoly vnořujte jen tehdy, když patří pod jeden nadřazený úkol.

Proč úkolový seznam ukazuje závorky místo políček

• Chybí mezera za závorkou: - [x]Done není úkol. Napište - [x] Done.
• Mezery uvnitř závorek: [ ] se dvěma mezerami nebo [ x ] je obyčejný text.
• Chybí značka seznamu: řádek, který začíná jen [ ], není položka seznamu.
• Text, který začíná závorkou. Dokumentace GitHubu radí závorku escapovat: napište - [ ] \(Optional) Test it.
• Renderer neumí GFM. Pak uvidíte závorky, ať napíšete cokoli.

Chcete-li zkontrolovat, jak plán s úkoly vypadá, otevřete soubor v DotMD, kde je čtení zdarma. Specifikace a plány se často píšou jako úkolové seznamy a políčka usnadňují přehlédnout i dlouhý seznam.

Otázky k zaškrtávacím políčkům v Markdownu

Další otázky