Guia da ferramenta
Sobre Visualizador de Markdown
Markdown Preview renderiza fonte Markdown em uma prévia legível para revisar títulos, listas, links, citações, tabelas e blocos de código.
Use antes de enviar README, trecho de documentação, issue ou rascunho de blog.
Como usar Markdown Preview
- Cole sua fonte Markdown.
- Use o exemplo para conferir tabelas GFM, fenced code blocks e links.
- Revise hierarquia de títulos, indentação de listas e renderização de links.
Quando usar
- Conferir linguagem de blocos de código e alinhamento de tabelas antes de commitar README.
- Pré-visualizar issue do GitHub ou release note antes de publicar.
- Inspecionar snippets de documentação API com headings e listas aninhadas.
Sintaxe Markdown e armadilhas de formatação
Markdown é leve, mas linhas em branco, indentação e quantidade de backticks afetam o render. GitHub Flavored Markdown adiciona tabelas, task lists e fenced code blocks.
- Títulos usam # e devem seguir hierarquia lógica.
- Listas aninhadas dependem de indentação; misturar tabs e espaços quebra layout.
- Fenced code blocks usam triple backticks e podem incluir linguagem.
- Texto de link deve ser descritivo, não apenas “click here”.
Perguntas frequentes sobre Prévia Markdown
- Suporta GitHub Flavored Markdown?
- Recursos comuns como tabelas, fenced code blocks e task lists podem ser vistos, mas o render final depende da plataforma alvo.
- Por que minha lista aninhada falhou?
- Geralmente é indentação ou linhas em branco. Indente itens filhos mais que o pai e mantenha o marcador consistente.
- Meu conteúdo é enviado?
- Não. O render Markdown roda localmente no navegador e não é enviado ao wetool.site.
Markdown Preview vs publicação
A prévia encontra muitos problemas, mas GitHub, npm, fóruns e CMS podem usar extensões e sanitização diferentes. Revise na plataforma final antes de publicar.
Comparação de dialetos Markdown
A preview ajuda a encontrar problemas de estrutura, mas Markdown dialects variam entre plataformas.
- CommonMark cobre syntax base como headings, paragraphs, lists, blockquotes e code blocks.
- GitHub Flavored Markdown adiciona extensions comuns como tables, task lists, strikethrough e autolinks.
- Blogs, CMS e documentation sites podem adicionar front matter, heading anchors, footnotes ou math formulas.
Render seguro e limites de publicação
Markdown preview não é o ambiente final de publicação, principalmente para HTML, imagens, links externos e filtros da plataforma.
- Não trate untrusted Markdown como safe HTML; plataformas alvo normalmente sanitize raw HTML.
- External images e links podem expor solicitação sources, token parameters ou internal addresses após publishing.
- Antes de publicar README, npm docs ou CMS pages, confira o final rendering na plataforma alvo.