Introdução ao Markdown

O que é Markdown?

Markdown é uma linguagem de marcação leve que você pode usar para adicionar formatação a documentos de texto simples. No GitHub, o Markdown é amplamente utilizado para criar arquivos README, issues, pull requests e comentários.

Sintaxe básica do Markdown

A seguir estão alguns exemplos básicos de sintaxe Markdown:

  • Cabeçalhos: Use o símbolo # para criar cabeçalhos. Quanto mais #, menor o nível do cabeçalho.

    # Cabeçalho 1

    ## Cabeçalho 2

  • Ênfase: Use asteriscos ou underscores para adicionar ênfase ao texto.

    *itálico* ou _itálico_

    **negrito** ou __negrito__

    Para mostrar o asterisco ou underscore como texto, use a barra invertida antes do caractere, por exemplo, \* ou \_ :

    \*isso não é itálico\*

  • Listas: Use hífens, asteriscos ou números para criar listas.

    - Item de lista não ordenada

    1. Item de lista ordenada

  • Links: Use colchetes e parênteses para criar links.

    [Texto do link](URL)

  • Imagens: Use um ponto de exclamação seguido de colchetes e parênteses para adicionar imagens.

    ![Texto alternativo](URL da imagem)

  • Citações em bloco: Use o símbolo > para criar citações em bloco.

    > Esta é uma citação em bloco.

  • Código: Use crases simples para código em linha e crases triplas para blocos de código.

    `código em linha`

    ```

    bloco de código

    ```

  • Tabelas: Use hífens e pipes para criar tabelas.

    | Cabeçalho 1 | Cabeçalho 2 |

    |-------------|-------------|

    | Célula 1 | Célula 2 |

  • Outras formatações: Para casos mais complexos, pode-se usar o HTML.

Sintaxe no GitHub

Referências cruzadas

Em issues e em PRs, é possível referenciar outras Issues e outros PRs pelo ID.

Exemplo de referências cruzadas no GitHub
Exemplo de referências cruzadas no GitHub

Também é possivel referenciar commits pelo seu ID/Hash e outras formas:

Outras formas de referências cruzadas no GitHub
Outras formas de referências cruzadas no GitHub

É possivel referenciar usuários com @nome-do-usuario.

Nos PRs e nas issues é possível criar uma lista de tarefas para acompanhar o progresso:

- [ ] Tarefa 1
- [x] Tarefa 2 (completa)

Comando em barra

É possivel fazer todas essas formatações usando atalhos/comandos de barra:

Comandos em barra no GitHub
Comandos em barra no GitHub