GitScrum
Testar grátis

Guia de Markdown

O GitScrum Studio suporta formatação Markdown em descrições de tarefas, comentários, páginas wiki e documentação. Este guia cobre toda a sintaxe suportada com exemplos.

Porquê Markdown

Markdown permite escrever conteúdo formatado sem sair do teclado. Sem botões para clicar, sem menus para navegar. Apenas escreva a sintaxe e veja o resultado.

Programadores já usam Markdown em READMEs, documentação e issue trackers. O GitScrum usa a mesma sintaxe que conhece do GitHub.

Formatação Básica

Cabeçalhos

Crie cabeçalhos com símbolos #:

# Cabeçalho 1
## Cabeçalho 2
### Cabeçalho 3
#### Cabeçalho 4

Ênfase

*itálico* ou _itálico_
**negrito** ou __negrito__
***negrito itálico***
~~riscado~~

Listas

Listas Não Ordenadas

- Item um
- Item dois
  - Item aninhado
- Item três

Listas Ordenadas

1. Primeiro item
2. Segundo item
   1. Aninhado numerado
3. Terceiro item

Listas de Tarefas

- [ ] Tarefa não concluída
- [x] Tarefa concluída
- [ ] Outra tarefa pendente

Links e Imagens

Links

[Texto do link](https://exemplo.com)
[Link com título](https://exemplo.com "Título ao passar")

Imagens

![Texto alternativo](url-imagem.png)

Código

Código Inline

Use crases para código inline: const x = 42;

Blocos de Código

Use três crases com linguagem opcional:

function hello(name) {
  return `Olá, ${name}!`;
}

Linguagens suportadas para syntax highlighting:

  • javascript, typescript, jsx, tsx
  • python, ruby, php
  • html, css, scss
  • json, yaml, markdown
  • bash, shell
  • sql
  • go, rust, java, c, cpp

Citações

> Esta é uma citação
> em várias linhas

> Citações aninhadas
>> Segundo nível
>>> Terceiro nível

Tabelas

| Cabeçalho 1 | Cabeçalho 2 | Cabeçalho 3 |
|-------------|-------------|-------------|
| Célula 1    | Célula 2    | Célula 3    |
| Célula 4    | Célula 5    | Célula 6    |

Alinhamento:

| Esquerda | Centro | Direita |
|:---------|:------:|--------:|
| E        |   C    |       D |

Funcionalidades Especiais

Menções

Mencione membros da equipa com @:

@joaosilva por favor reveja isto

Referências de Tarefas

Link para tarefas com #:

Relacionado com #123
Bloqueia #456

Etiquetas

Referencie etiquetas com ~:

Adicionar etiqueta ~bug

Melhores Práticas

Descrições de Tarefas

  • Comece com uma frase de resumo clara
  • Use cabeçalhos para organizar secções
  • Inclua blocos de código para detalhes técnicos
  • Adicione listas de tarefas para critérios de aceitação

Páginas Wiki

  • Use cabeçalhos descritivos para navegação
  • Inclua índice para páginas longas
  • Link para páginas relacionadas

Comentários

  • Seja conciso
  • Cite contexto relevante
  • Use blocos de código para logs/erros
  • Mencione pessoas que precisam ver

Erros Comuns

Sem espaço após #

❌ #Cabeçalho
✅ # Cabeçalho

Listas aninhadas quebradas

❌ 
- Item
 - Aninhado (só 1 espaço)

✅ 
- Item
  - Aninhado (2 espaços)

Como Reportar um Problema ou Solicitar uma Funcionalidade

Se o markdown não está a renderizar corretamente ou precisa de suporte de sintaxe adicional, submeta feedback através do GitScrum Studio. Na Barra Lateral, clique em Tickets de Suporte e abra um ticket.

← Previous Next →