Jak dodać pole wyboru w Markdown:składnia listy zadań i przykłady.

Składnia listy zadań w Markdown

Lista zadań to zwykła lista, której pozycje zaczynają się od znacznika pola. Przepis ma trzy części:

1. Znacznik listy

   Myślnik, gwiazdka lub plus, po których następuje spacja: -. Działa też pozycja numerowana, np. 1..

2. Pole w nawiasach kwadratowych

   [ ] z jedną spacją w środku to puste pole. [x] to zaznaczone; wielkie [X] też się liczy. Nic innego nie może stać między nawiasami.

3. Spacja, potem tekst

   Bez spacji po ] linia zostaje zwykłym tekstem z nawiasami.

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

Tak widzi to czytelnik:

• Napisać specyfikację
• Dodać przypadki brzegowe
• Zdobyć przegląd
• Przekazać ją agentowi

Zagnieżdżone pola wyboru

Zrób wcięcie zadania pod innym, by powstało podzadanie. Dwie spacje działają w większości rendererów; cztery są najbezpieczniejsze:

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

Możesz mieszać zadania ze zwykłymi punktami na tej samej liście i umieścić akapit, kod lub cytat pod zadaniem, wcinając go do poziomu tekstu zadania. Pole nadrzędne nie zaznacza się samo, gdy podzadania są gotowe; zaznaczasz je sam.

Gdzie wyświetlają się pola wyboru Markdown

• GitHub pokazuje listy zadań jako pola wyboru w plikach Markdown, zgłoszeniach, pull requestach i komentarzach. W zgłoszeniu lub pull requeście możesz zaznaczyć pole na stronie, a GitHub zmieni tekst za ciebie.
• Aplikacje Markdown stosujące GFM też je pokazują. W DotMD pojawiają się jako pola w czytniku. Tam pola są tylko do odczytu: aby zaznaczyć jedno, edytuj linię i zmień [ ] na [x].
• Minimalne parsery, które znają tylko oryginalny Markdown lub CommonMark, pokazują tekst taki, jaki jest, z nawiasami. Nadal czyta się go jak listę rzeczy do zrobienia, tylko bez pól.

Jeśli używasz DotMD Editor, naciśnięcie Enter na końcu zadania zaczyna następne z pustym - [ ], więc możesz wpisywać kolejne pozycje.

Znak zaznaczenia w Markdown bez listy zadań

Gdy chcesz haczyk w tabeli lub zdaniu, a nie na liście, wpisz sam znak. Symbole Unicode to tekst, więc pojawiają się w każdej aplikacji Markdown:

GitHub przyjmuje też skróty emoji, takie jak :white_check_mark:. To funkcja GitHuba: w innej aplikacji mogą się pokazać jako surowy tekst, więc wybierz sam znak, jeśli plik będzie czytany gdzie indziej.

Listy zadań w planach i specyfikacjach

Listy zadań nie służą tylko aplikacjom do zadań. Plan lub specyfikacja napisane w Markdown często kończą się listą tego, co zostało do zrobienia, a każdy krok łatwo przejrzeć w jego linii:

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

Niech każde zadanie będzie jedną czynnością, którą można skończyć i sprawdzić. Użyj nagłówka dla każdej grupy i zagnieżdżaj podzadania tylko wtedy, gdy należą do jednego zadania nadrzędnego.

Dlaczego lista zadań pokazuje nawiasy zamiast pól

• Brak spacji po nawiasie: - [x]Gotowe nie jest zadaniem. Napisz - [x] Gotowe.
• Spacje wewnątrz nawiasów: [ ] z dwiema spacjami lub [ x ] to zwykły tekst.
• Brak znacznika listy: linia zaczynająca się samym [ ] nie jest pozycją listy.
• Tekst zaczynający się od nawiasu. Dokumentacja GitHuba każe poprzedzić nawias ukośnikiem: napisz - [ ] \(Opcjonalnie) Przetestuj.
• Renderer nie obsługuje GFM. Wtedy widzisz nawiasy, cokolwiek wpiszesz.

Aby sprawdzić, jak wygląda plan z zadaniami, otwórz plik w DotMD, gdzie czytanie jest bezpłatne. Specyfikacje i plany często pisze się jako listy zadań, a pola ułatwiają przejrzenie długiej listy.

Pytania o pola wyboru w Markdown

Więcej pytań