O que é Markdown
Markdown é uma forma de escrever texto com marcação simples que vira estrutura. Você usa símbolos como cerquilha, asterisco e hífen para indicar títulos, listas e ênfase.
A proposta é manter o documento legível no texto puro e convertê-lo para HTML quando necessário. O mesmo arquivo serve para leitura direta e para a interface final.
Uma marcação leve
Uma linha iniciada por cerquilha indica um título, e um hífen cria um item de lista. A sintaxe básica permite escrever a maior parte da documentação sem decorar tags.
A leveza ajuda o versionamento. Um arquivo Markdown muda em trechos pequenos no controle de versão, e a diferença entre versões fica clara para quem revisa.
Limites e variações
Cada ferramenta interpreta um subconjunto do Markdown. Tabelas e notas de rodapé, que um editor aceita, podem não existir em outro.
Para evitar diferença de renderização, use a sintaxe comum e confira o documento na plataforma de destino. A escrita técnica ajuda a achar o tom e a organização que funcionam no texto e na estrutura.
Para revisar a documentação de um projeto construído com agentes, o Desenvolvimento Colaborativo da Dev Side Studio permite conferir o arquivo e a página gerada durante a sessão.
Dúvidas frequentes
Perguntas frequentes sobre Markdown
- Markdown é o mesmo que HTML?
- Não. O HTML marca a estrutura de uma página com tags, e o Markdown usa símbolos simples que uma ferramenta converte depois. O Markdown fica legível no texto puro.
- Toda ferramenta interpreta Markdown igual?
- Não. A sintaxe básica é comum, e extensões variam entre plataformas. O que funciona em um editor pode ser interpretado de outra forma em outra ferramenta.
- Posso misturar Markdown e HTML?
- Em muitos processadores, sim, mas isso reduz a portabilidade. Prefira a sintaxe padrão e use HTML apenas quando a marcação precisa de algo que o Markdown não cobre.
Para continuar
Recursos relacionados
Documentação
Markdown: guia de John Gruber
Apresenta a proposta original de escrever em texto simples e converter para HTML.
Abrir recursoDocumentação
CommonMark: especificação
Padroniza a sintaxe para que várias ferramentas interpretem o mesmo documento.
Abrir recursoAplicação na formação
Developer Workspace
O Markdown organiza a documentação e as instruções do projeto em um formato legível e versionável.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.