Caso de uso
Revisar documentação técnica Markdown no navegador
Abra READMEs, RFCs e especificações Markdown com índice automático, progresso e navegação estruturada. Sem instalar ferramentas, sem cadastro.
Neste artigo
Equipes de desenvolvimento, revisores técnicos e analistas frequentemente precisam revisar documentação Markdown que chega como arquivos .md de repositórios, como links de PRs, ou como especificações enviadas por e-mail. Abrir esses arquivos em um editor de código ou em uma plataforma Git funciona, mas não oferece estrutura de navegação para documentos longos.
O Sanctuary Reader foi desenvolvido especificamente para esse fluxo: abrir um documento Markdown e navegar por ele com conforto, independentemente do tamanho.
O problema com documentação longa
Documentação técnica raramente é curta. READMEs de projetos complexos, RFCs, ADRs (Architecture Decision Records), especificações de API e guias de integração facilmente chegam a dezenas ou centenas de seções.
Sem uma ferramenta de navegação adequada, revisar esses documentos significa:
- Rolar indefinidamente para encontrar uma seção específica
- Perder o contexto de onde você está no documento
- Não ter visão da estrutura geral antes de começar a ler
- Demorar para localizar a próxima seção relevante no documento renderizado
Como o Sanctuary Reader resolve
Índice automático
Ao abrir qualquer documento Markdown, o Sanctuary Reader gera automaticamente um índice com base nos títulos (#, ##, ###). O índice aparece no painel lateral e permite navegar diretamente para qualquer seção com um clique.
Para documentos muito longos, o índice vira o mapa principal da revisão: ele mostra a hierarquia do material e acompanha a seção ativa conforme você avança.
Barra de progresso e métricas
No topo da página aparece uma barra de progresso mostrando sua posição no documento. O painel lateral exibe o número de palavras, o tempo estimado de leitura e a quantidade de seções — informações úteis para planejar quanto tempo alocar para a revisão.
Modo foco
O modo foco destaca a seção atual e esmaece o restante do documento. Útil para revisar seção por seção sem perder o fio.
Fluxo de revisão típico
- Abra o documento — por upload de arquivo, URL raw do repositório, ou colando o conteúdo
- Escaneie o índice para entender a estrutura antes de ler
- Navegue pelas seções que precisam de revisão usando o índice
- Use o modo foco para revisar seções densas sem distração
- Registre observações por seção nos cards de estudo ou no estudo guiado
- Abra o editor ao vivo para fazer correções diretas com preview
- Exporte o arquivo
.mdcorrigido
Formatos de documentação suportados
O Sanctuary Reader renderiza corretamente:
- Blocos de código com syntax highlighting para dezenas de linguagens
- Tabelas formatadas com alinhamento
- Diagramas Mermaid — fluxogramas, sequências, classes, diagramas ER
- Listas de tarefas com checkboxes
- HTML inline básico dentro do Markdown
- Links e referências cruzadas dentro do documento
Veja mais em Renderização Markdown no Sanctuary.
Como abrir o documento
Três formas comuns para documentação técnica:
- URL raw do GitHub/GitLab: botão “Abrir por URL” → cole o link do arquivo raw
- Arquivo local: botão “Abrir Arquivo” ou arraste o
.mdpara a janela - Conteúdo copiado: botão “Colar Texto” → cole o Markdown
Veja o guia completo em Como abrir documentos Markdown.
Recursos relacionados
- Índice automático e navegação estrutural — como o índice e o progresso funcionam em detalhe
- Editor ao vivo com preview — fazer edições com feedback imediato
- Cards de estudo e estudo guiado — registrar notas por seção durante a revisão