Visualizador e preview de README.md

Confira um README antes de dar push. Abra o arquivo, cole o texto ou solte um link do GitHub e veja badges, tabelas, blocos de código, listas de tarefas, alertas e diagramas Mermaid renderizados do jeito que o GitHub mostra.

Visualizar um README

Grátis · sem cadastro · roda no seu navegador, nada é enviado

O README do markdown-it aberto de uma URL do GitHub, renderizado com badges, alertas e código em GitHub Dark — Um README real aberto direto de um link do GitHub: badges, alertas, tabelas e código aparecem como no GitHub.

Abra um README do GitHub ou do disco

Cole uma URL do GitHub como https://github.com/user/repo/blob/main/README.md em Abrir → De uma URL — o visualizador a transforma no link do arquivo raw para você e renderiza. Links do Gist funcionam do mesmo jeito. Para um projeto na sua máquina, solte o README.md na página ou cole o conteúdo no editor.

Tudo o que o GitHub renderiza, renderizado do mesmo jeito

GitHub-Flavored Markdown é um dialeto específico, e os READMEs se apoiam nos seus extras: tabelas com barras, listas de tarefas - [ ], ~~tachado~~, URLs com link automático, alertas > [!NOTE] / [!WARNING], seções <details> para instruções de instalação longas, badges do shields.io, âncoras de título relativas e código cercado com rótulos de linguagem. Tudo isso é renderizado aqui, com os mesmos ids de título que o GitHub gera, então seus links internos continuam funcionando. Diagramas Mermaid — que o GitHub também desenha — são renderizados também.

Corrija antes do commit

Mude para o layout Dividido e edite o README com prévia ao vivo: a barra de ferramentas insere tabelas e listas de tarefas, os atalhos cuidam de negrito, links e títulos, e a estrutura mostra se a organização das seções está boa de ler. Baixe o .md quando estiver do seu jeito, ou copie o HTML renderizado para o site do projeto. README não é o único arquivo Markdown de um repositório: arquivos de instruções como CLAUDE.md e AGENTS.md abrem do mesmo jeito — veja o visualizador de CLAUDE.md.

Veja em ação

Alertas Note, Important, Warning e Caution no estilo GitHub, uma citação e uma seção details recolhível no tema GitHub Dark — Alertas no estilo GitHub, citações e seções <details> recolhíveis, em GitHub Dark.

Blocos de código TypeScript, Python, Bash e diff com realce de sintaxe, rótulos de linguagem e botões de copiar — Os blocos de código ganham rótulo de linguagem, realce de sintaxe para mais de 50 linguagens e botão de copiar — este é o tema One Dark.

Fórmula KaTeX em modo de exibição e um fluxograma Mermaid renderizados dentro da prévia — Fórmulas KaTeX e fluxogramas Mermaid são renderizados direto no documento.

Como funciona

1
Cole um link de README do GitHub em Abrir → De uma URL, ou solte o arquivo na página.
2
Leia renderizado, com badges, tabelas, código e diagramas no lugar.
3
Edite no modo Dividido e depois baixe o README.md atualizado.

O que você recebe

Links do GitHub, convertidos

URLs blob e Gist viram arquivos raw automaticamente.

GFM completo

Tabelas, listas de tarefas, alertas, notas de rodapé, details, badges, links automáticos, emoji.

Diagramas Mermaid

Diagramas de arquitetura e de fluxo são renderizados no lugar.

Temas escuros e claros

Confira como o README fica em GitHub Dark e em Light.

Edite com prévia

Corrija problemas de formatação e baixe o arquivo corrigido.

Privado

Arquivos locais nunca saem do seu navegador; buscas por URL não são armazenadas.

Perguntas frequentes

Vai ficar idêntico ao GitHub?

As regras de Markdown e os ids de título correspondem ao GitHub-Flavored Markdown, e os temas GitHub Light / Dark usam as cores do GitHub. Pequenas diferenças de espaçamento são possíveis, mas estrutura, tabelas, código e alertas são renderizados da mesma forma.

Posso visualizar o README de um repositório privado?

Não por URL, porque o servidor não consegue se autenticar no GitHub. Baixe o arquivo e solte na página em vez disso — ele fica no seu dispositivo.

Links de imagem relativos funcionam?

Imagens com URLs absolutas são renderizadas. Caminhos relativos como docs/logo.png não podem ser resolvidos para um arquivo local; ao abrir de uma URL do GitHub, use caminhos raw.githubusercontent.com.

Os badges aparecem?

Sim. Badges são imagens comuns com URLs absolutas e são renderizados normalmente.

Posso renderizar um README de outro site, não do GitHub?

Sim, qualquer URL pública que retorne um arquivo Markdown funciona. Páginas HTML são rejeitadas para você saber que precisa usar o link raw.

Ferramentas relacionadas

Pronto quando você estiver

Cole Markdown, solte um arquivo ou abra uma URL — a prévia aparece na hora e tudo fica no seu dispositivo.

Abrir o Markdown Viewer