Nada muito complicado, só o que você precisa para deixar seus READMEs mais organizados.
Os títulos são marcados pelas '#', por exemplo:
# Título 1
## Título 2
### Título 3
#### Título 4
##### Título 5
- Negrito: Colocamos o texto entre asteriscos ou underlines duplos
**Exemplo** ou __Exemplo__
- Itálico: Colocamos o texto entre asterisco ou underline
*Exemplo* ou _Exemplo_
- Também podemos usar as duas enfâses:
***Exemplo*** ou ___Exemplo___
- Links Titulados:
[]() - [Título do link](aquitucolocaolink.com)
- Links Diretos
Apenas colocar URl: https://aquitucolocaolink.com
- Links Âncora : Links como o do sumário desse guia
[]() - [Título do Link](#titulo-minusculo-separado-por-hifen)
Exemplo Titulado: Clique aqui para ver que é real!
Exemplo Direto: https://github.com
Exemplo Âncora: Sumário
- Tópicos
- Item 1
- Item 1.1
- Item 1.2
- Item 2
- Item 3
- Item 1
- Item 1.1
- Item 1.2
- Item 2
- Item 3
- Lista Numerada
1. Item 1
2. Item 2
3. Item 3
Exemplo :
- Item 1
- Item 2
- Item 3
- Linha de código : Colocar a linha entre ` (acento grave)
print("Hello World!")
- Múltiplas linhas de código : Colocar a o conteúdo entre ``` (três acentos graves)
if(int i = 0; i<10; i++)
{
printf(i);
printf("\n");
}
- Podemos especificar a linguagem que será apresentada nas linhas de códigos escrevendo seu nome logo após os três acentos graves, por exemplo: ```python
print("Esta é uma linha em python!")
![]() - ![Título da imagem](Link da imagem)
Exemplo :
Nomes | Valores | Qtd. -> Colunas separadas por '|'
:----:|:-------:|:---: -> Linhas que separam a legenda do conteúdo são feitas
Produto 1 | R$ 1 | 1 com '---', os ':' alinham o texto das colunas,
Produto 2 | R$ 2 | 2 quando colocados em apenas uma das laterais alinham
Produto 3 | R$ 3 | 3 pela esquerda ou direita, e quando colocado nas
Produto 4 | R$ 4 | 4 duas laterais centralizam o texto
Exemplo :
Nomes | Valores | Qtd. |
---|---|---|
Produto 1 | R$ 1 | 1 |
Produto 2 | R$ 2 | 2 |
Produto 3 | R$ 3 | 3 |
Produto 4 | R$ 4 | 4 |