Testar Sintaxe

Referencia de Sintaxe

O que e Sintaxe Markdown?

Markdown e uma linguagem de formatacao de texto simples e leve criada por John Gruber em 2004. Ela usa simbolos e caracteres simples para marcar texto, facilitando a escrita de conteudo que converte para HTML sem parecer confuso em sua forma bruta. Markdown se tornou o padrao para documentacao, arquivos README, blogs e qualquer conteudo que precise de formatacao simples e legivel.

CommonMark e a especificacao mais amplamente aceita para Markdown, definindo como os parsers devem interpretar a sintaxe. Ao aprender sintaxe compativel com CommonMark, seu conteudo sera renderizado consistentemente no GitHub, GitLab, Discord, Slack, Reddit, Stack Overflow e dezenas de outras plataformas. A especificacao original do Markdown de John Gruber permanece fundamental, enquanto extensoes como GitHub Flavored Markdown adicionam recursos como listas de tarefas, tachado e tabelas.

O Markdown moderno vem em varios sabores adaptados a plataformas especificas. GitHub Flavored Markdown (GFM) adiciona tabelas, checkboxes e autolinks. GitLab Markdown suporta extensoes similares mais diagramas. Aprender a sintaxe core do CommonMark oferece uma base portavel que funciona em qualquer lugar.

Como Usar o Guia de Sintaxe Markdown

Siga estes passos para aprender e testar a sintaxe Markdown. Cada passo usa os paineis reais desta pagina.

Colar, Enviar ou Carregar Exemplo

Cole Markdown no painel esquerdo Testar Sintaxe, ou clique em Enviar para carregar um arquivo .md. Clique em Exemplo para ver docs de API de exemplo. O painel direito Referencia de Sintaxe mostra padroes CommonMark e GFM.

Praticar e Consultar

Use a referencia para titulos, enfase, listas, links, tabelas, blocos de codigo. Copie exemplos no painel esquerdo para testa-los. Cobre CommonMark mais extensoes GitHub Flavored Markdown.

Copiar ou Baixar

Clique em Copiar ou Baixar para salvar a referencia. Use Limpar para recomectar. Todo o processamento ocorre no seu navegador.

Quando Voce Realmente Usaria Isso

Escrevendo Documentacao

Documentacao tecnica, guias de referencia de API e documentacao de software sao quase universalmente escritos em Markdown. Docs do Python, guias do Node.js e a maioria dos projetos open source usam Markdown para seus sites de documentacao. Uma referencia de sintaxe mantem voce produtivo ao escrever documentacao complexa.

README e Arquivos de Projeto

Todo projeto no GitHub tem um arquivo README.md descrevendo o projeto, uso, instalacao e diretrizes de contribuicao. Esses arquivos sao escritos inteiramente em Markdown e sao frequentemente a primeira coisa que os usuarios veem.

Criacao e Publicacao de Conteudo

Plataformas de blog como Jekyll, Hugo e Ghost aceitam Markdown para conteudo. Plataformas estilo Medium e geradores de sites estaticos usam Markdown como formato de entrada principal. Conhecer a sintaxe ajuda a escrever mais rapido e manter formatacao consistente.

Comunicacao Colaborativa

Slack, Discord, issues do GitHub, comentarios de pull request e posts em foruns suportam formatacao Markdown. Ao revisar codigo, reportar bugs ou colaborar em chat, Markdown permite formatar sua mensagem claramente sem quebrar o fluxo da conversa.

Perguntas Frequentes (FAQ)

Posso usar HTML dentro do Markdown?

Sim, Markdown permite misturar HTML bruto. Se o Markdown nao suporta algo que voce precisa, pode escrever HTML diretamente e ele passara para a saida. No entanto, isso reduz a portabilidade e legibilidade do seu codigo-fonte. De acordo com a especificacao CommonMark, blocos HTML e HTML inline sao reconhecidos e passados sem alteracao.

Qual a diferenca entre asteriscos e sublinhados para enfase?

Funcionalmente, sao identicos no CommonMark — *texto* e _texto_ produzem italico, **texto** e __texto__ produzem negrito. A escolha e estilistica. Muitas equipes preferem asteriscos por consistencia e por serem mais faceis de digitar.

Como funcionam as quebras de linha no Markdown?

Esta e uma fonte comum de confusao. Uma unica quebra de linha na fonte e tratada como um espaco. Para criar uma quebra de linha real (<br> no HTML), adicione dois espacos no final da linha antes de pressionar Enter, ou use uma barra invertida antes da quebra de linha. Para quebras de paragrafo, use uma linha em branco. A especificacao CommonMark explica isso em detalhes.

Tabelas sao suportadas em todas as plataformas Markdown?

Nao. Tabelas fazem parte do GitHub Flavored Markdown e outras extensoes, mas nao estao na especificacao CommonMark. A maioria das plataformas modernas (GitHub, GitLab, Discord) as suporta, mas alguns parsers ignoram a sintaxe de pipes.

Como escapo caracteres especiais?

Use uma barra invertida (\) antes de caracteres com significado especial no Markdown: barra invertida (\), crase (`), asterisco (*), sublinhado (_), chaves ({}), colchetes ([]), parenteses (()), hash (#), mais (+), menos (-), ponto (.) e exclamacao (!). Por exemplo, \*nao italico\* renderiza os asteriscos literalmente.

Qual a melhor forma de formatar codigo no Markdown?

Para codigo inline, use crases simples: `codigo aqui`. Para blocos de codigo, use crases triplas com uma tag de linguagem opcional (```javascript) para destaque de sintaxe. Evite indentar codigo como bloco de codigo — blocos cercados sao mais claros e mais portaveis.

Guia de Sintaxe Markdown