Ferramenta

Abrir um Markdown a partir de uma URL

Cole o endereço de um arquivo .md público — inclusive a página do arquivo no GitHub — e leia o conteúdo formatado na hora. A busca é feita pelo seu navegador, sem servidor no meio.

README.md Exemplo carregado

Markdown edite à vontade

Código Markdown do documento

# sanctuary-cli

**Build:** passando · **Licença:** MIT · **Node:** 20 ou 22

Ferramenta de linha de comando para converter, validar e publicar documentos
Markdown. Sem dependências fora da biblioteca padrão.

## Instalação

```bash
npm install -g sanctuary-cli
sanctuary --version
```

## Uso

```bash
# valida links e cabeçalhos de um diretório inteiro
sanctuary lint ./docs --strict

# gera o sumário e grava no próprio arquivo
sanctuary toc README.md --write
```

## Opções

| Flag | Padrão | Descrição |
| --- | --- | --- |
| `--strict` | `false` | Trata aviso como erro |
| `--write` | `false` | Grava no arquivo em vez de imprimir |
| `--format` | `md` | `md`, `html` ou `json` |

## Contribuindo

1. Abra uma issue descrevendo o problema antes do PR.
2. Rode `npm test` — a suíte precisa passar em Node 20 e 22.
3. Commits seguem *Conventional Commits*.

## Licença

MIT © Sanctuary

Pré-visualização ao vivo

sanctuary-cli

Build: passando · Licença: MIT · Node: 20 ou 22

Ferramenta de linha de comando para converter, validar e publicar documentos Markdown. Sem dependências fora da biblioteca padrão.

Instalação

npm install -g sanctuary-cli
sanctuary --version

Uso

# valida links e cabeçalhos de um diretório inteiro
sanctuary lint ./docs --strict

# gera o sumário e grava no próprio arquivo
sanctuary toc README.md --write

Opções

Flag	Padrão	Descrição
`--strict`	`false`	Trata aviso como erro
`--write`	`false`	Grava no arquivo em vez de imprimir
`--format`	`md`	`md`, `html` ou `json`

Contribuindo

Abra uma issue descrevendo o problema antes do PR.
Rode npm test — a suíte precisa passar em Node 20 e 22.
Commits seguem Conventional Commits.

Licença

MIT © Sanctuary

URL raw e página do arquivo

Repositórios servem dois endereços para o mesmo arquivo. A página (github.com/usuario/repo/blob/main/README.md) devolve HTML, com a barra lateral, o histórico e o botão de editar. O arquivo bruto (raw.githubusercontent.com/usuario/repo/main/README.md) devolve o Markdown em si.

Só o segundo serve para ler o conteúdo — e é o que quase sempre falta quando um visualizador online devolve erro. Aqui os dois funcionam: quando o endereço colado é reconhecido como página de arquivo do GitHub, do GitLab ou do Bitbucket, a URL raw equivalente é montada antes da busca.

Serviço	O que colar
GitHub	A página `/blob/` ou o link `raw.githubusercontent.com`
GitLab	A página `/-/blob/` ou o link `/-/raw/`
Bitbucket	A página `/src/` ou o link `/raw/`
Outros	Qualquer URL pública que responda texto Markdown

Quando abrir por URL compensa

Revisar um README antes do commit — veja como o arquivo vai aparecer, sem publicar.
Ler documentação de uma biblioteca sem clonar o repositório inteiro.
Conferir um documento compartilhado por link em vez de baixar e procurar um editor.
Comparar versões de um arquivo abrindo duas URLs em abas diferentes.

O artigo abrir README no navegador mostra o fluxo completo, e a página do guia sobre abrir Markdown lista os quatro caminhos aceitos: texto colado, arquivo local, arrastar e soltar, e URL.

O que não funciona, e por quê

Repositório privado não funciona: a busca sai do seu navegador, sem token e sem autenticação, e o servidor responde 404. O mesmo vale para arquivos atrás de VPN ou de login. Nesses casos o caminho é baixar o arquivo e colar o conteúdo no editor — o resultado é idêntico.

Endereços que respondem HTML são recusados de propósito, mesmo terminando em .md. Renderizar a página inteira de um repositório como se fosse documento produziria um texto sem sentido; é mais útil avisar e apontar o link bruto.

Nada passa por um servidor nosso

A requisição vai do seu navegador direto para o endereço informado. Não há proxy, fila nem registro do que foi aberto — o que também significa que o servidor de destino precisa liberar a leitura por outra origem, o que os serviços de arquivo bruto fazem por padrão. Os detalhes de armazenamento estão na política de privacidade.

Perguntas frequentes

Preciso usar a URL raw do GitHub?

Não precisa. Se você colar o endereço da página do arquivo no GitHub, GitLab ou Bitbucket, a URL raw equivalente é resolvida automaticamente antes da busca.

Funciona com repositório privado?

Não. A busca é feita pelo seu navegador, sem autenticação, então o arquivo precisa estar acessível publicamente. Para um arquivo privado, baixe-o e cole o conteúdo no editor.

Por que apareceu um aviso de que o endereço devolveu uma página?

Porque a URL informada responde HTML em vez do arquivo. Isso acontece com links de visualização que não têm equivalente raw conhecido — nesse caso, use o botão de arquivo bruto do próprio serviço.

Existe limite de tamanho?

Sim, 2 MB de texto. Documentos maiores devem ser divididos ou abertos por seção.