1. O Que É Markdown

Markdown é uma linguagem de marcação leve criada por John Gruber em 2004, com o objetivo de ser legível como texto plano e ao mesmo tempo conversível para HTML de forma automática. A premissa central é que a formatação deve ser intuitiva — usar **negrito** é mais natural do que digitar <strong>negrito</strong>.

Hoje, Markdown é onipresente no desenvolvimento de software: é a linguagem padrão de READMEs no GitHub, documentações no Notion, posts em plataformas como Dev.to e Hashnode, e mensagens em Slack e Discord. Aprender Markdown é uma habilidade essencial para qualquer desenvolvedor ou redator técnico.

2. Sintaxe Básica e Avançada

A sintaxe do Markdown cobre desde formatações simples até elementos estruturais complexos:

• Cabeçalhos: use # para H1, ## para H2, até ###### para H6.
• Ênfase: **negrito**, *itálico*, ~~tachado~~.
• Listas: use - ou * para listas não ordenadas e números para ordenadas.
• Links: [texto](url) para links inline; referências [texto][id] para links separados.
• Imagens: ![alt](url) — idêntico a links, mas com ! no início.
• Código: crases simples para inline, três crases para blocos com suporte a linguagem.
• Tabelas: separadores | e linhas de alinhamento com - e :.
• Citações: prefixo > no início da linha.

"A beleza do Markdown está na sua invisibilidade: você pode ler o arquivo fonte sem renderização e entender perfeitamente o conteúdo."

3. GitHub Flavored Markdown (GFM)

O GitHub Flavored Markdown (GFM) é a extensão mais difundida do Markdown padrão, adicionando recursos essenciais para documentação técnica:

• Tabelas com alinhamento de colunas por :.
• Listas de tarefas: - [x] Tarefa concluída e - [ ] Tarefa pendente.
• Realce de código por linguagem: ```javascript ativa syntax highlighting.
• Autolink: URLs e referências a issues/PRs são convertidas automaticamente em links.
• Tachado: ~~texto~~ renderiza como texto tachado.

Este editor usa a biblioteca marked.js, que implementa GFM por padrão, garantindo compatibilidade com o estilo GitHub de renderização.

4. Onde o Markdown É Usado

Markdown tornou-se o padrão de facto para texto estruturado em ambientes técnicos:

• GitHub / GitLab / Bitbucket: READMEs, issues, pull requests, wikis e comentários.
• Documentação: ferramentas como MkDocs, Docusaurus e VitePress constroem sites inteiros a partir de arquivos .md.
• Blogs e CMS: Hugo, Jekyll, Ghost, Notion e muitas plataformas de conteúdo aceitam Markdown nativamente.
• Comunicação: Slack, Discord, Microsoft Teams e Jira suportam subsets de Markdown em mensagens.
• Notebooks: Jupyter Notebooks usam Markdown em células de texto para documentar código.
• Emails e apresentações: ferramentas como Marp e Slidev convertem Markdown em slides profissionais.

5. Boas Práticas de Escrita em Markdown

Adotar convenções consistentes facilita a leitura, manutenção e colaboração em documentos Markdown:

• Use apenas um H1 por documento — ele representa o título principal.
• Prefira uma linha em branco antes e depois de blocos de código, listas e citações.
• Limite as linhas a 80–120 caracteres para facilitar revisões em diffs de git.
• Use referências de link para URLs longas ou repetidas — mantém o texto legível.
• Adicione texto alternativo descritivo em imagens para acessibilidade.
• Evite HTML inline a menos que seja estritamente necessário — isso quebra a portabilidade.
• Mantenha uma linha em branco no final do arquivo (convenção POSIX).

6. Perguntas Frequentes

O que é marked.js?

marked.js é uma biblioteca JavaScript de alta performance para converter Markdown em HTML. É usada por este editor e por milhares de projetos ao redor do mundo. Suporta a spec CommonMark e GFM, é executada inteiramente no cliente e processa textos grandes muito rapidamente.

Meu conteúdo é salvo?

Não. O editor funciona totalmente no seu navegador — nenhum texto é enviado a servidores externos. Se quiser persistência, use o botão "Baixar .md" para salvar o arquivo localmente.

Posso usar este editor para escrever READMEs do GitHub?

Sim! O preview usa o mesmo estilo visual do GitHub (GitHub Flavored Markdown), então o que você vê aqui é muito próximo do que aparecerá no repositório. Use os botões de toolbar para inserir tabelas, blocos de código com linguagem e listas de tarefas.

Qual é a diferença entre Markdown e HTML?

Markdown é uma linguagem de marcação simplificada, legível como texto plano, que é compilada para HTML. HTML é a linguagem de marcação nativa dos navegadores, mais verbosa e poderosa, mas menos agradável para escrever manualmente. O Markdown cobre bem 90% dos casos de formatação de texto com uma sintaxe muito mais limpa.