Sintaxe Markdown do GitHub
Aprenda o que é Markdown e um resumo das principais sintaxes do GitHub Flavored Markdown para hospedar blogs no GitHub Pages.
Para utilizar o GitHub Pages, é necessário conhecer a sintaxe markdown. Este texto foi escrito com base nos documentos oficiais do GitHub Mastering Markdown e Basic writing and formatting syntax.
1. O que é Markdown
Markdown é uma linguagem de marcação leve baseada em texto simples. É usada para criar documentos formatados usando texto simples e se caracteriza por ter uma sintaxe mais simples e fácil em comparação com linguagens de marcação comuns. É facilmente convertida em HTML e Rich Text Format (RTF), sendo muito utilizada em arquivos README distribuídos com software e em postagens online.
John Gruber criou a linguagem Markdown em 2004, com uma colaboração significativa de Aaron Swartz na sintaxe, com o objetivo de permitir que as pessoas “escrevam usando um formato de texto simples fácil de ler e escrever”, e que possa ser opcionalmente convertido em XHTML (ou HTML) estruturalmente válido.
2. Sintaxe Markdown
Como não há um padrão definido para Markdown, a sintaxe detalhada pode variar um pouco dependendo de onde é usada. A sintaxe Markdown resumida aqui é baseada no GitHub Flavored Markdown.
2.1. Quebra de linha, separação de parágrafos
No Markdown, pressionar Enter uma vez não é reconhecido como uma quebra de linha.
1
2
3
Primeira frase.
Segunda frase.
Terceira frase.
Primeira frase. Segunda frase. Terceira frase.
A quebra de linha é aplicada quando dois ou mais espaços são inseridos consecutivamente.
1
2
3
Primeira frase.
Segunda frase.
Terceira frase.
Primeira frase.
Segunda frase.
Terceira frase.
Parágrafos são separados por uma linha em branco (pressionar Enter duas vezes).
1
2
3
Um parágrafo.
Outro parágrafo.
Um parágrafo.
Outro parágrafo.
2.2. Cabeçalhos
Existem 6 níveis no total.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Em princípio, deve haver apenas uma tag H1 por página, então geralmente não há muitas ocasiões para usá-la diretamente ao escrever posts ou documentos.
2.3. Ênfase
1
2
3
4
5
6
7
8
9
10
11
*This text is italicized*
_This is italicized too_
**This is bold text**
__This is bold text too__
~~This was mistaken text~~
_You **can** combine them_
***All this text is important***
This text is italicized
This is italicized too
This is bold text
This is bold text too
This was mistaken text
You can combine them
All this text is important
2.4. Citação de texto
Use >.
1
2
3
> This is a first blockquote.
>> This is a second blockquote.
>>> This is a third blockquote.
This is a first blockquote.
This is a second blockquote.
This is a third blockquote.
2.5. Citação de código
Use ``` ou ~~~.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
Você também pode especificar a linguagem de programação para ativar o realce de sintaxe.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Links
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
Você também pode usar links de caminho relativo para apontar para outros arquivos no repositório. O uso é o mesmo que no terminal.
1
[README](../README.md)
2.7. Lista não ordenada
Use - ou *.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Lista ordenada
Use números.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Lista aninhada
1
2
3
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
2.10. Lista de tarefas
Para criar uma lista de tarefas, adicione [ ] antes de cada item. Para marcar uma tarefa como concluída, use [x].
1
2
3
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
- Finish my changes
- Push my commits to GitHub
- Open a pull request
2.11. Anexar imagens
1
2
3
4
Método: {(opcional)opções adicionais}
{: .align-center}
{: width="50%" height="50%"}
2.12. Criar tabelas
Você pode criar tabelas usando | e -. Deve haver uma linha em branco antes da tabela para que seja exibida corretamente. É necessário usar pelo menos três - para que seja reconhecido corretamente.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |