Visualizador de README do GitHub: cole ou abra um README, veja a prévia GFM e defina uma URL base para links relativos. Nada é buscado no GitHub.
O que é GitHub README Viewer?
O GitHub README Viewer é uma ferramenta online gratuita que mostra a prévia de um README escrito em GitHub Flavored Markdown (GFM) no seu navegador. Cole ou abra o README, defina uma URL base para os links relativos e leia a página renderizada. Nada é buscado no GitHub.
O que ela aceita
- GFM: tabelas, listas de tarefas, tachado e código em bloco.
- URL base (opcional): uma URL http ou https sem credenciais que resolve links relativos como docs/guide.md. Sem ela, links relativos ficam indisponíveis.
Bom saber
- A prévia é aproximada e não é o renderizador do GitHub, então recursos que o GitHub acrescenta ao GFM podem aparecer de outro jeito ou não aparecer.
- Imagens, selos e outros arquivos para os quais o README aponta não são carregados: a imagem aparece como o texto alternativo, e a ferramenta avisa dos arquivos ausentes.
- Um README em um endereço remoto não é buscado. Cole ou abra o texto dele. Esta ferramenta não é afiliada ao GitHub.
Como usar GitHub README Viewer?
- Cole o texto do README ou abra o arquivo.
- Se quiser que os links relativos sejam resolvidos, informe uma URL base.
- Leia a Prévia e a lista Links e imagens indisponíveis. Este painel não oferece Copiar nem Baixar.
Exemplo
Um README com um selo e um link relativo, e a URL base https://github.com/acme/my-app/blob/main/.
# my-app

See [the guide](docs/guide.md).O link para docs/guide.md vira https://github.com/acme/my-app/blob/main/docs/guide.md, e o selo aparece como o texto alternativo, Build status.
Limites e privacidade
Limites
- Texto: até 2.000.000 bytes em UTF-8 (cerca de 2 MB). Letras acentuadas e emojis ocupam mais de um byte cada. Uma entrada ou um texto gerado maior é recusado.
Meu conteúdo é enviado para um servidor?
Não. Seu conteúdo e seus arquivos são processados no navegador e nunca enviados. O OCR e a leitura de PDF baixam arquivos de processamento, incluindo dados de idioma do OCR e o worker de PDF, deste mesmo site apenas quando essas ferramentas rodam; nenhum conteúdo vai para terceiros. Prévias Markdown mostram imagens externas como texto alternativo, sem carregá-las.
Copiar coloca um resultado na área de transferência e baixar o salva como arquivo, mas só quando você aperta o botão. O arquivo é criado no seu navegador, então nada é enviado.
Para ver os detalhes completos, consulte a Política de Privacidade
Ferramentas e páginas relacionadas
Converta de ou para outros formatos, ou trabalhe com o mesmo conteúdo nestas ferramentas.