- Títulos
- Parágrafos e quebras de linha
- Ênfase
- Links
- Blocos de citação
- Listas
- Imagens
- Tabelas
- Task List
- Código inline e em bloco
- Backslash Scapes
- Referências
Para marcar um título, utilizar # a quantidade de vezes que irá representar o nível do título. Exemplo:
# Título nível 1:
## Título nível 2:
### Título nível 3:
#### Título nível 4:
##### Título nível 5:
###### Título nível 6:
Para gerar parágrafos, escrever o texto pulando uma linha, ou colocar dois espaços em branco ao final:
Parágrafo 1.
Parágrafo 2.
Parágrafo 3.
Para itálico, utilizar * ou _.
_Exemplo de texto_
Exemplo de texto
Para negrito, utilizar ** ou __.
**Exemplo de texto**
Exemplo de texto
Para negrito e itálico, utilizar ***.
***Exemplo de texto***
Exemplo de texto
Para riscado, utilizar ~~.
~~Exemplo de texto~~
Exemplo de texto
Para gerar links, utilizar [] e ().
Dentro de [] colocar o texto do link e dentro de () colocar a URL:
[Link Aqui](http://www.link.com):
Pode-se informar um texto após a URL, separando o link do texto por um espaço em branco.
Esse texto será usado como title:
[Link Aqui](http://www.link.com "Clique aqui para acessar"):
Se o texto do seu link é o próprio link, pode-se envolvê-lo entre <>, que o link será gerado automaticamente:
<https://www.google.com.br>
E funciona também para e-mails:
<meu@email.com>
Para criar um bloco de citação, utilizar > no início da linha.
> Esse é um bloco de citação:
> Ele pode ter várias linhas por parágrafo.
>
> Inclusive, dando um espaço, você tem um novo parágrafo.
Esse é um bloco de citação. Ele pode ter várias linhas por parágrafo.
Inclusive, dando um espaço, você tem um novo parágrafo.
Para listas não ordenadas, utilizar *, + ou -.
* Item 1
+ Item 2
- Item 3
- Item 1
- Item 2
- Item 3
Para listas ordenadas, utilizar o número seguido de .:
1. Item 1
2. Item 2
3. Item 3
- Item 1
- Item 2
- Item 3
Geração de imagens é bem parecido com a geração de links: você só precisa adicionar uma ! no início. E o texto que você coloca entre os colchetes, é usado como alt na imagem:
Para adicionar imagens, utilizar como links, adicionando ! no início.
O title também funciona como no link:
Para criar tabelas, utilizar | para separar colunas e - para separar linha de título:
| Alimentos | Preço |
| --------- | ----- |
| Arroz | R$ 10 |
| Feijão | R$ 8 |
| Batata | R$ 7 |
| Macarrão | R$ 8 |
| Alimentos | Preço |
|---|---|
| Arroz | R$ 10 |
| Feijão | R$ 8 |
| Batata | R$ 7 |
| Macarrão | R$ 8 |
Não é necessário alinhar com espaços, mas visualmente fica melhor.
Para alinhar o conteúdo, utilizar : nos - que ficam abaixo do título da tabela.
Se utilizar : no lado esquerdo, o alinhamento será feito à esquerda (padrão);
Se utilizar : no lado direito, o alinhamento será feito à direita;
Para centralizar, utilizar dos dois lados.
| Alimentos | Preço |
|---|---|
| Arroz | R$ 10 |
| Feijão | R$ 8 |
| Batata | R$ 7 |
| Macarrão | R$ 8 |
Para criar uma lista de tarefas, utilizar a notação - [ ] Texto da task (para itens desmarcados) ou - [x] Texto da task (para itens marcados):
- Comprar arroz
- Comprar feijão
- Comprar batata
- Comprar macarrão
Para adicionar código a nível inline, utilizar crase:
O `<blockquote>` é uma tag HTML.
O <blockquote> é uma tag HTML.
Para gerar blocos de código, utilizar três crases no início da primeira e última linha, para marcar o início e o fim do bloco:
function sayHello() {
return 'Hi';
}
Você ainda pode definir qual a linguagem que está sendo utilizada, para que seja feito code highlight no seu código. Para isso, informar a linguagem após as 3 crases, dessa forma:
function sayHello() {
return 'Hi';
} # Clonando o repositório
$ git clone https://github.com/ahcantarim/readmePara escapar caracteres que são parseados pelo [Markdown], utilizar a barra invertida \ (backslash) seguida do caractere, para imprimí-lo literalmente. O escape funciona para os caracteres listados abaixo:
\ backslash (barra invertida)
` backtick (crase)
* asterisk (asterisco)
_ underscore
{} curly braces (chaves)
[] square brackets (colchetes)
() parentheses (parênteses)
# hash mark (sustenido)
+ plus sign (sinal de "mais" ou somar)
- minus sign (hyphen) (sinal de "menos" ou hífen)
. dot (ponto)
! exclamation mark (ponto de exclamação)
Além de tudo isso, é importante saber também, que é possível usar HTML junto com [Markdown]. Se você precisar adicionar uma classe em uma imagem para alinhar, ou colocar uma cor específica em alguma palavra, você pode usar tags HTML normalmente.
Sintaxe básica de escrita e formatação no GitHub
This project is under the MIT license. See the file LICENSE for more details.