So fügst du in Markdown eine Checkbox ein:Syntax und Beispiele für Aufgabenlisten.

Die Syntax von Markdown-Aufgabenlisten

Eine Aufgabenliste ist eine normale Liste, deren Einträge mit einer Checkbox-Markierung beginnen. Das Rezept hat drei Teile:

1. Ein Listenzeichen

   Ein Bindestrich, ein Sternchen oder ein Plus, gefolgt von einem Leerzeichen: -. Ein nummerierter Eintrag wie 1. funktioniert auch.

2. Ein Kästchen in eckigen Klammern

   [ ] mit einem Leerzeichen darin ist ein leeres Kästchen. [x] ist ein angehaktes; auch ein großes [X] zählt. Mehr darf nicht zwischen den Klammern stehen.

3. Ein Leerzeichen, dann der Text

   Ohne Leerzeichen nach ] bleibt die Zeile normaler Text mit Klammern darin.

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

So sieht es für den Leser aus:

• Draft the spec
• Add the edge cases
• Get a review
• Hand it to the agent

Verschachtelte Checkboxen

Rücke eine Aufgabe unter einer anderen ein, um eine Teilaufgabe zu erhalten. Zwei Leerzeichen genügen in den meisten Renderern; vier sind am sichersten:

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

Du kannst Aufgaben und normale Aufzählungspunkte in derselben Liste mischen und unter eine Aufgabe einen Absatz, Code oder ein Zitat setzen, indem du es auf den Text der Aufgabe einrückst. Das übergeordnete Kästchen hakt sich nicht selbst an, wenn die untergeordneten erledigt sind; das machst du selbst.

Wo Markdown-Checkboxen gerendert werden

• GitHub zeigt Aufgabenlisten in Markdown-Dateien, Issues, Pull Requests und Kommentaren als Kontrollkästchen. In einem Issue oder Pull Request kannst du ein Kästchen auf der Seite anhaken, und GitHub ändert den Text für dich.
• Markdown-Apps, die GFM folgen, zeigen sie ebenfalls. In DotMD erscheinen sie im Reader als Kästchen. Dort sind sie schreibgeschützt: Zum Anhaken bearbeitest du die Zeile und änderst [ ] in [x].
• Minimale Parser, die nur das ursprüngliche Markdown oder CommonMark kennen, zeigen den Text unverändert mit den Klammern. Er liest sich trotzdem wie eine To-do-Liste, nur nicht als Kästchen.

Wenn du DotMD Editor nutzt, beginnt Enter am Ende einer Aufgabe die nächste mit einem leeren - [ ], sodass du einfach weitertippen kannst.

Ein Markdown-Häkchen ohne Aufgabenliste

Willst du ein Häkchen in einer Tabelle oder einem Satz statt in einer Liste, tippe das Zeichen selbst. Unicode-Symbole sind Text und erscheinen daher in jeder Markdown-App:

GitHub akzeptiert auch Emoji-Kurzbefehle wie :white_check_mark:. Sie sind eine GitHub-Funktion: In einer anderen App erscheinen sie vielleicht als roher Text, nimm also lieber das Zeichen selbst, wenn die Datei woanders gelesen wird.

Aufgabenlisten in Plänen und Specs

Aufgabenlisten sind nicht nur für To-do-Apps. Ein Plan oder eine Spec in Markdown endet oft mit einer Checkliste dessen, was noch zu tun ist, und jeder Schritt lässt sich in seiner Zeile einzeln prüfen:

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

Halte jede Aufgabe bei einer Handlung, die sich abschließen und prüfen lässt. Nimm für jede Gruppe eine Überschrift und verschachtele Teilaufgaben nur, wenn sie zu einer übergeordneten gehören.

Warum eine Aufgabenliste Klammern statt Kästchen zeigt

• Kein Leerzeichen nach der Klammer: - [x]Done ist keine Aufgabe. Schreibe - [x] Done.
• Leerzeichen in den Klammern: [ ] mit zwei Leerzeichen oder [ x ] ist normaler Text.
• Kein Listenzeichen: Eine Zeile, die nur mit [ ] beginnt, ist kein Listeneintrag.
• Text, der mit einer Klammer beginnt. Laut GitHub-Dokumentation musst du die Klammer maskieren: Schreibe - [ ] \(Optional) Test it.
• Dem Renderer fehlt GFM. Dann siehst du die Klammern, was du auch tippst.

Um zu prüfen, wie ein Plan mit Aufgaben aussieht, öffne die Datei in DotMD, wo Lesen kostenlos ist. Specs und Pläne werden oft als Aufgabenlisten geschrieben, und die Kästchen machen eine lange Liste leicht überschaubar.

Fragen zu Markdown-Checkboxen

Weitere Fragen