Editor Markdown para documentação técnica

Documentação técnica escrita em Markdown raramente é apenas texto. Ela costuma misturar instalação, comandos, exemplos de API, tabelas de configuração, diagramas Mermaid, decisões de arquitetura e links para outras páginas.

Por isso, um editor Markdown para documentação técnica precisa ir além do campo de texto com preview. Ele precisa ajudar a ler, revisar, navegar e só então editar.

O Sanctuary Reader foi desenhado para esse fluxo: abrir um documento Markdown existente, entender a estrutura, revisar com índice e usar o editor ao vivo quando houver algo para corrigir.

O que documentação técnica exige de um editor Markdown

Para README, RFC, ADR, especificações e guias internos, procure estes recursos:

Preview ao vivo para validar o resultado enquanto edita
Syntax highlighting para exemplos de código
Tabelas legíveis para configuração, suporte e comparação
Mermaid para fluxos, sequência e arquitetura
Índice automático para documentos longos
Carregamento por arquivo, texto ou URL
Exportação do .md final

Sem esses recursos, a revisão vira uma alternância entre editor, navegador, terminal e ferramenta de diagrama.

Fluxo recomendado de revisão

Abra o documento no visualizador Markdown online
Use o índice para entender a estrutura geral
Revise exemplos de código, tabelas e links
Confira diagramas Mermaid no próprio documento
Abra o editor com preview ao vivo para corrigir trechos
Exporte o arquivo Markdown atualizado

Esse fluxo evita editar antes de entender o documento inteiro. Em documentação técnica, contexto importa tanto quanto sintaxe.

Exemplo de documentação técnica

# API de cobrança

## Autenticação

Todas as requisições usam token Bearer.

```http
GET /v1/invoices
Authorization: Bearer TOKEN
```

## Estados da fatura

| Estado | Significado |
|---|---|
| pending | Aguardando pagamento |
| paid | Pagamento confirmado |
| failed | Falha no pagamento |

Esse tipo de arquivo precisa de preview para código, tabela e estrutura. Se também houver Mermaid, o editor deve renderizar o diagrama sem exigir exportação para imagem.

README, RFC e ADR têm necessidades diferentes

Tipo	O que revisar
README	Instalação, uso, exemplos e links
RFC	Contexto, decisão, alternativas e riscos
ADR	Decisão arquitetural, status e consequências
Guia interno	Passo a passo, pré-requisitos e manutenção

O mesmo editor pode atender todos, desde que facilite navegação e revisão. Para READMEs, veja como abrir README no navegador. Para revisão mais ampla, veja revisar documentação técnica Markdown.

Como o Sanctuary Reader ajuda

O Sanctuary Reader combina leitura e edição:

Abre .md, .markdown e .txt
Gera índice a partir dos títulos
Renderiza tabelas, código e Mermaid
Mostra métricas de leitura
Oferece modo foco e cards de estudo
Permite editar com preview ao vivo e exportar
Transforma seções em slides para apresentação

Isso é especialmente útil quando a documentação já existe e precisa ser revisada antes de publicar.

Próximos passos

Abrir o editor Markdown para documentação técnica →