Como usar o editor de Markdown
- Digite ou cole o Markdown no editor à esquerda.
- Veja a pré-visualização ao vivo ser atualizada enquanto você escreve, renderizada com o Markdown no estilo do GitHub (GFM).
- Clique em Copiar HTML para copiar o HTML gerado para um site, um CMS ou um e-mail.
- Ou copie o próprio Markdown para um README, uma issue, um pull request ou uma página de documentação.
A renderização acontece no seu navegador, e o seu texto não é enviado nem armazenado. O HTML renderizado é sanitizado, então scripts e atributos perigosos no conteúdo colado são removidos antes de a pré-visualização ser exibida.
O que é Markdown?
Markdown é uma linguagem de marcação leve criada por John Gruber em 2004. Ela usa a pontuação do texto simples para a formatação: # para títulos, * ou _ para ênfase, - para listas. O código-fonte continua legível como texto simples, e um renderizador o transforma em HTML.
A descrição original deixou muitos casos extremos sem definição, então as implementações discordavam entre si. O CommonMark é uma especificação detalhada que resolve essas ambiguidades, e o Markdown no estilo do GitHub é um superconjunto do CommonMark que acrescenta recursos que os desenvolvedores usam todos os dias:
| Recurso do GFM | Sintaxe |
|---|---|
| Tabelas | | Name | Value | com uma linha separadora |---|---| |
| Listas de tarefas | - [ ] todo e - [x] done |
| Texto tachado | ~~removed~~ |
| Links automáticos | URLs soltas, como https://example.com, viram links |
| Blocos de código delimitados | Três crases, opcionalmente seguidas do nome de uma linguagem |
Referência rápida de Markdown
# Heading 1
## Heading 2
**bold**, *italic*, `inline code`
- Bullet item
- Nested item (indent two spaces)
1. Numbered item
[Link text](https://example.com)

> A blockquote
```python
print("fenced code with a language")
```
Problemas comuns do Markdown e como resolvê-los
O título não é renderizado. O CommonMark exige um espaço depois das cerquilhas (#). #Title é texto simples; # Title é um título.
Linhas unidas em um único parágrafo. Uma única quebra de linha dentro de um parágrafo é tratada como um espaço. Deixe uma linha em branco para começar um novo parágrafo, ou termine uma linha com dois espaços ou uma barra invertida para uma quebra de linha forçada. (Os comentários do GitHub tratam as quebras de linha simples de forma diferente dos arquivos README, o que é uma fonte comum de confusão.)
Lista ou bloco de código que se interrompe antes da hora. O conteúdo que pertence a um item de lista deve ser recuado para se alinhar com o texto do item. Para código dentro de uma lista, recue o bloco delimitado inteiro:
1. Install the package:
```bash
npm install example
```
2. Run it.
A tabela não é renderizada. Uma tabela GFM precisa de uma linha de cabeçalho, de uma linha separadora com pelo menos três traços por coluna e, em geral, de uma linha em branco antes dela. Use dois-pontos no separador (:---, :---:, ---:) para alinhar as colunas.
Formatação indesejada. Caracteres como *, _ e # podem acionar a formatação. Escape-os com uma barra invertida, por exemplo \*not italic\*, ou coloque-os entre crases.
Dicas e boas práticas
- Sempre acrescente uma linguagem depois das crases de abertura para que os blocos de código recebam realce de sintaxe onde houver suporte.
- Escreva um texto alternativo significativo para as imagens; ele é usado por leitores de tela e exibido quando a imagem não carrega.
- Use uma frase por linha em documentos longos; o Markdown as junta em parágrafos, e os diffs ficam muito mais limpos.
- Cole exemplos de JSON ou YAML primeiro no formatador de JSON ou no formatador de YAML, para que os blocos de código da sua documentação sejam válidos e organizados.
- Se você colar o HTML gerado em uma página da web, passe-o pelo formatador de HTML para recuá-lo de forma organizada.
Perguntas frequentes
Qual a diferença entre Markdown e Markdown no estilo do GitHub?
O GFM é um superconjunto do Markdown CommonMark definido pelo GitHub. Ele acrescenta tabelas, listas de tarefas, texto tachado, links automáticos estendidos e algumas restrições ao HTML bruto. A maioria dos READMEs escritos para o GitHub é renderizada aqui da mesma maneira.
Posso usar HTML dentro do Markdown?
Sim, o Markdown permite HTML em linha. Por segurança, a pré-visualização sanitiza a saída, então tags como <script>, atributos de manipuladores de eventos como onclick e links javascript: são removidos.
Por que meu Markdown fica diferente em outro site?
As plataformas usam variantes diferentes de Markdown e as suas próprias folhas de estilo. A sintaxe básica (títulos, ênfase, listas, links, código) é consistente, mas tabelas, quebras de linha e extensões como notas de rodapé ou matemática variam entre os renderizadores.
Como converto Markdown em HTML?
Escreva ou cole o seu Markdown, confira a pré-visualização e clique em Copiar HTML. A saída é HTML semântico simples (títulos, parágrafos, listas, tabelas) sem estilo, então ele assume o CSS da página em que você o colar.
Atualizado