Guia de Sintaxe Markdown: Do Basico ao Avancado

O que e Markdown e por que aprender

Markdown e uma linguagem de marcacao leve criada por John Gruber em 2004. Ela permite escrever texto formatado usando sintaxe simples e legivel que e convertida para HTML. A ideia central e que o texto fonte seja tao facil de ler quanto o resultado formatado.

Markdown se tornou o padrao de fato para:

• GitHub: READMEs, issues, pull requests e wikis usam Markdown.
• Documentacao tecnica: Ferramentas como MkDocs, Docusaurus e GitBook usam Markdown.
• Blogs e CMS: WordPress, Ghost, Hugo e dezenas de outras plataformas suportam Markdown.
• Notas pessoais: Obsidian, Notion, Typora e outros apps de notas usam Markdown.
• Comunicacao: Slack, Discord e Reddit usam variantes de Markdown para formatacao.

Para praticar e visualizar seu Markdown em tempo real, use nosso Previsualizador Markdown.

Formatacao basica de texto

A sintaxe fundamental do Markdown:

• Titulos: Use # para H1, ## para H2, ate ###### para H6. Sempre deixe um espaco apos o #.
• Negrito: **texto em negrito** ou __texto em negrito__
• Italico: *texto em italico* ou _texto em italico_
• Negrito e italico: ***texto***
• Riscado: ~~texto riscado~~
• Paragrafos: Separe paragrafos com uma linha em branco. Uma quebra de linha simples nao cria um novo paragrafo.
• Quebra de linha: Termine a linha com dois espacos antes da quebra, ou use <br>.

Listas, links e imagens

Listas

• Lista nao ordenada: Use -, * ou + no inicio da linha. Indente com 2 ou 4 espacos para sublistas.
• Lista ordenada: Use numeros seguidos de ponto: 1., 2., 3.. Os numeros nao precisam ser sequenciais — Markdown renumera automaticamente.
• Lista de tarefas: - [ ] para item pendente, - [x] para concluido. Funciona no GitHub e na maioria dos editores modernos.

Links e imagens

• Link: [texto do link](https://url.com)
• Link com titulo: [texto](https://url.com "Titulo ao passar o mouse")
• Imagem: ![texto alternativo](url-da-imagem.jpg)
• Link de referencia: [texto][ref] com [ref]: https://url.com em outra parte do documento. Util para textos longos com muitos links.

Codigo e citacoes

Markdown tem suporte excelente para exibicao de codigo:

• Codigo inline: Use crases simples: `codigo aqui`
• Bloco de codigo: Use tres crases com o nome da linguagem para syntax highlighting:

```javascript
const soma = (a, b) => a + b;
```

Linguagens suportadas incluem javascript, python, html, css, bash, json, typescript e dezenas de outras.

• Citacao (blockquote): Use > no inicio da linha. Para citacoes aninhadas, use >>.

Tabelas e recursos avancados

Tabelas em Markdown usam pipes (|) e hifens:

| Coluna 1 | Coluna 2 | Coluna 3 |
|----------|----------|----------|
| Dado 1 | Dado 2 | Dado 3 |

Alinhamento: :--- (esquerda), :---: (centro), ---: (direita).

Outros recursos

• Linha horizontal: ---, *** ou ___ em uma linha sozinha.
• Notas de rodape: [^1] no texto e [^1]: Texto da nota no final. Suportado pelo GitHub e muitos renderizadores.
• HTML inline: Markdown aceita HTML direto. <details><summary>Clique</summary>Conteudo oculto</details> cria um acordeao.
• Escapando caracteres: Use \ antes de metacaracteres para exibi-los literalmente: \*nao e italico\*.

GitHub Flavored Markdown e outras variantes

O Markdown original de John Gruber e bastante basico. Variantes estendem a sintaxe:

• GitHub Flavored Markdown (GFM): Adiciona tabelas, listas de tarefas, riscado, autolinks, blocos de codigo com fence e mencoes (@usuario). E o mais usado em projetos open source.
• CommonMark: Uma especificacao rigorosa do Markdown que resolve ambiguidades da versao original. Muitos renderizadores modernos seguem CommonMark.
• MDX: Markdown com componentes React. Usado em documentacao tecnica moderna para inserir componentes interativos no conteudo.

Na pratica, se voce dominar GFM, estara coberto para 90% dos usos. Para visualizar e editar Markdown em tempo real, acesse nosso Previsualizador Markdown.

Dicas de produtividade com Markdown

• Escreva primeiro, formate depois. Nao se preocupe com formatacao perfeita no primeiro rascunho. A forca do Markdown e ser rapido de escrever.
• Use atalhos do editor. No VS Code, Ctrl+B insere negrito, Ctrl+I insere italico. Muitos editores Markdown tem atalhos similares.
• Mantenha documentos curtos. Um README de 500 linhas ninguem le. Divida em multiplos documentos e use links entre eles.
• Inclua um indice. Para documentos longos, adicione um indice no topo com links para cada secao usando [Secao](#id-da-secao).