Como adicionar uma caixa de seleção em Markdown:sintaxe da lista de tarefas e exemplos.

Sintaxe da lista de tarefas em Markdown

Uma lista de tarefas é uma lista normal cujos itens começam com um marcador de caixa. A receita tem três partes:

1. Um marcador de lista

   Um traço, um asterisco ou um sinal de mais, seguido de um espaço: -. Um item numerado como 1. também funciona.

2. Uma caixa entre parênteses retos

   [ ] com um espaço dentro é uma caixa vazia. [x] é uma marcada; um [X] maiúsculo também conta. Mais nada vai entre os parênteses.

3. Um espaço e depois o texto

   Sem o espaço depois de ], a linha fica como texto simples com parênteses.

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

Eis o que o leitor vê:

• Redigir a especificação
• Acrescentar os casos-limite
• Obter uma revisão
• Entregá-la ao agente

Caixas de seleção aninhadas

Indente uma tarefa debaixo de outra para criar uma subtarefa. Dois espaços funcionam na maioria dos renderizadores; quatro são o mais seguro:

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

Pode misturar tarefas com marcadores normais na mesma lista, e pôr um parágrafo, código ou uma citação debaixo de uma tarefa indentando-o ao nível do texto da tarefa. A caixa-mãe não se marca sozinha quando as filhas estão concluídas; marca-a você.

Onde as caixas de seleção em Markdown aparecem

• O GitHub mostra as listas de tarefas como caixas em ficheiros Markdown, issues, pull requests e comentários. Numa issue ou numa pull request pode marcar uma caixa na página e o GitHub edita o texto por si.
• As aplicações Markdown que seguem o GFM também as mostram. No DotMD aparecem como caixas no leitor. Aí as caixas são só de leitura: para marcar uma, edite a linha e mude [ ] para [x].
• Os analisadores mínimos que só conhecem o Markdown original ou o CommonMark mostram o texto tal como está, com os parênteses. Continua a ler-se como uma lista de tarefas, apenas sem caixas.

Se usar o DotMD Editor, ao premir Enter no fim de uma tarefa começa a seguinte com um - [ ] vazio, para continuar a escrever itens.

Um visto em Markdown sem lista de tarefas

Quando quiser um visto numa tabela ou numa frase, e não numa lista, escreva o próprio carácter. Os símbolos Unicode são texto, por isso aparecem em todas as aplicações Markdown:

O GitHub também aceita atalhos de emoji como :white_check_mark:. São uma funcionalidade do GitHub: noutra aplicação podem aparecer como texto bruto, por isso prefira o carácter quando o ficheiro for lido noutro sítio.

Listas de tarefas em planos e especificações

As listas de tarefas não servem só para aplicações de tarefas. Um plano ou uma especificação escritos em Markdown acabam muitas vezes com uma lista do que falta fazer, e cada passo é fácil de rever na sua linha:

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

Mantenha cada tarefa numa só ação que se possa concluir e verificar. Use um título para cada grupo e aninhe subtarefas só quando pertencem a uma única tarefa-mãe.

Porque é que uma lista de tarefas mostra parênteses em vez de caixas

• Sem espaço depois do parêntese: - [x]Feito não é uma tarefa. Escreva - [x] Feito.
• Espaços dentro dos parênteses: [ ] com dois espaços, ou [ x ], é texto simples.
• Sem marcador de lista: uma linha que começa só com [ ] não é um item de lista.
• Texto que começa com um parêntese. A documentação do GitHub manda fazer escape do parêntese: escreva - [ ] \(Opcional) Testar.
• O renderizador não tem GFM. Nesse caso vê os parênteses, escreva o que escrever.

Para ver o aspeto de um plano com tarefas, abra o ficheiro no DotMD, onde a leitura é gratuita. As especificações e os planos escrevem-se muitas vezes como listas de tarefas, e as caixas facilitam percorrer uma lista longa.

Perguntas sobre caixas de seleção em Markdown

Mais perguntas