Converter e pré-visualizar Markdown

Painel
Documentação
API

converte o seu Markdown em HTML e mostra uma pré-visualização em direto, ideal para escrever READMEs, documentação ou artigos

O que é o Markdown?

O Markdown é uma linguagem de marcação leve criada por John Gruber em 2004. Permite escrever texto formatado utilizando uma sintaxe simples e legível no estado bruto, que é depois convertida em HTML.

Esta ferramenta utiliza a especificação GFM (GitHub Flavored Markdown), a variante mais difundida, que acrescenta o suporte de tabelas, caixas de seleção, blocos de código com coloração sintática e ligações automáticas.

A pré-visualização à direita é atualizada em tempo real enquanto escreve. O botão Submeter gera o código HTML correspondente, que pode copiar ou transferir.

Sintaxe básica do Markdown

Markdown	Resultado
`# Título 1`	Título <h1>
`## Título 2`	Título <h2>
`negrito`	negrito
`itálico`	itálico
`código inline`	`código inline`
```php ... ```	Bloco de código PHP
`[texto](url)`	Hiperligação
`![alt](url)`	Imagem
`- item`	Lista não ordenada
`1. item`	Lista ordenada
`> citação`	Blockquote
`---`	Separador horizontal

Casos de utilização comuns

README do GitHub: escrever a documentação de um projeto de código aberto.
Documentação técnica: escrever guias, wikis ou páginas de documentação (MkDocs, Docusaurus, Hugo).
Artigos de blogue: a maioria dos CMS (Jekyll, Ghost, Contentful) aceita Markdown.
Comentários e issues: o GitHub, GitLab, Jira, Notion e Slack suportam todos o GFM.
Emails formatados: converter Markdown em HTML para integrar num email HTML.
Notas e apresentações: o Obsidian, Notion, Marp e Reveal.js utilizam Markdown.

Perguntas frequentes

Qual é a diferença entre o Markdown padrão e o GFM?

O Markdown padrão (CommonMark) abrange os elementos básicos: títulos, listas, ligações, código. O GFM (GitHub Flavored Markdown) acrescenta as tabelas, as listas de tarefas (- [ ] item), o código delimitado com linguagem (```php), as menções e as ligações automáticas. Esta ferramenta utiliza o GFM através da biblioteca league/commonmark.

O HTML gerado é seguro?

Sim. O conversor está configurado para remover as etiquetas HTML brutas (html_input: strip) e bloquear as ligações não seguras, o que impede os ataques XSS. O HTML produzido é adequado para integração numa página web existente.

Posso incluir HTML no meu Markdown?

Por motivos de segurança, o HTML bruto inserido no Markdown é removido durante a conversão. Se precisar de uma renderização HTML personalizada, escreva diretamente o HTML pretendido.

Qual é o tamanho máximo do documento?

Não existe um limite rígido do lado do servidor para esta ferramenta. Para documentos muito longos (mais de alguns milhares de linhas), a pré-visualização em tempo real pode ficar mais lenta consoante o seu navegador.

Exemplo de pedido

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Esquema de entrada

Campo	Tipo	Obrigatório	Predefinição
`input`	text		–

Pontos de acesso

GET https://cdrn.fr/api/v1/tools - lista todas as ferramentas disponíveis
GET https://cdrn.fr/api/v1/tools/markdown-formatter - obtém o esquema desta ferramenta
POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - executa esta ferramenta com um payload JSON