Ao documentar suas soluções ou ao contribuir com o projeto, é útil conhecer alguns aspectos básicos da sintaxe do Markdown. Aqui estão alguns dos mais utilizados:
Use #
para cabeçalhos. Mais #
s significam níveis de cabeçalho menores.
# Cabeçalho 1
## Cabeçalho 2
### Cabeçalho 3
#### Cabeçalho 4
- Negrito: Use
**texto**
ou__texto__
. - Itálico: Use
*texto*
ou_texto_
. Tachado: Use~~texto~~
.
Use -
, *
, ou +
para itens de lista não ordenada.
- Item 1
- Item 2
- Subitem 2.1
- Subitem 2.2
Use números seguidos de um ponto para listas ordenadas.
1. Primeiro item
2. Segundo item
1. Subitem 2.1
2. Subitem 2.2
Para inserir um link, use o formato [texto do link](URL)
. Por exemplo:
[GitHub](https://github.com/)
Para adicionar imagens, use o formato ![texto alternativo](URL da imagem)
. Por exemplo:
![Logo do GitHub](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Para incluir um bloco de código, use três crases ``` antes e depois do código. Para especificar a linguagem, adicione o nome dela diretamente após as crases de abertura.
Bloco de código sem especificar a linguagem:
git clone URL_DO_REPOSITÓRIO
Bloco de código especificando a linguagem (por exemplo, bash):
git clone URL_DO_REPOSITÓRIO
Para criar uma citação, use >
antes do texto.
> Esta é uma citação.