Arquivos README.md são feitos para serem lidos renderizados. Quando você abre o arquivo bruto fora de uma plataforma como GitHub ou GitLab, vê apenas texto Markdown. Para revisar com conforto, o ideal é abrir o README no navegador com formatação.
O Sanctuary Reader permite abrir README local, colar o conteúdo ou carregar uma URL pública do arquivo raw. Depois disso, o documento aparece com títulos, listas, blocos de código, tabelas, Mermaid e índice automático.
Quando abrir um README fora do repositório
Há vários cenários em que o README não está em uma página já renderizada:
- Você baixou um projeto e quer ler
README.mdlocalmente - Recebeu um README por e-mail, Slack ou issue
- Está revisando uma alteração antes de abrir pull request
- Precisa comparar o README com uma especificação ou changelog
- Quer apresentar a estrutura do projeto em uma reunião
Nesses casos, abrir o arquivo em texto puro atrapalha a leitura, principalmente quando há tabelas e exemplos de código.
Opção 1: abrir README.md local
Se o arquivo está no seu computador:
- Acesse o visualizador Markdown online
- Escolha a opção de arquivo
- Selecione
README.md - Leia o conteúdo renderizado no navegador
O arquivo local é processado no seu dispositivo. Isso é útil para projetos privados ou documentação ainda não publicada.
Opção 2: abrir README por URL raw
Se o README está em um repositório público, copie a URL raw do arquivo. No GitHub, abra o arquivo e use o botão “Raw”. Depois cole a URL no Sanctuary Reader.
Esse fluxo funciona para documentação pública, exemplos open source e arquivos hospedados em CDNs. Para conteúdo privado, prefira arquivo local, porque a URL pública depende da origem remota estar acessível.
O que revisar em um README
Ao abrir o README com preview, confira:
- Se o primeiro H1 explica claramente o projeto
- Se a instalação tem comandos copiáveis
- Se exemplos de código têm linguagem no code fence
- Se tabelas de configuração estão legíveis
- Se links internos e externos fazem sentido
- Se diagramas Mermaid renderizam sem erro
Um README técnico precisa ser escaneável. O índice automático ajuda a enxergar rapidamente se há seções demais, se alguma seção está faltando ou se a ordem está confusa.
Exemplo de estrutura mínima
# Nome do projeto
## Instalação
```bash
npm install
```
## Uso
```bash
npm run dev
```
## Configuração
| Variável | Descrição |
|---|---|
| API_URL | URL da API |Se esse conteúdo renderiza com títulos, comandos e tabela, o README fica muito mais fácil de revisar.
Depois da leitura
Se encontrar problemas, abra o editor ao vivo, corrija o Markdown e baixe o .md atualizado. Para fluxos de equipe, veja também revisar documentação técnica Markdown e editor Markdown para documentação técnica.