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.
Origem
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.
Coloque um badge na sua documentação
Quem abre o seu README pelo arquivo cru vê caracteres, não um documento: sem títulos, sem tabelas, sem nada para percorrer com o olho. Um badge perto do topo dá a essa pessoa um clique para ler o mesmo arquivo formatado, com índice. Cole o endereço do seu .md e copie o Markdown.
É este o badge, no tamanho real.
O link bruto — o que devolve o Markdown em si, não a página do repositório.
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.
Um link compartilhado mantém essa propriedade. O endereço viaja no fragmento — tudo depois do
# — e navegador nenhum envia fragmento para servidor. Um link que abre um documento
não deixa rastro nos nossos registros nem nos de quem hospedou a página onde o link estava.
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.
Dá para mandar um link que já abre o documento renderizado?
Dá. O endereço do arquivo vai no fragmento do link — /ferramentas/markdown-por-url/#url= seguido do endereço codificado — e a página abre o documento ao carregar. O gerador de badge desta página monta esse link pronto.
É seguro clicar num link montado por outra pessoa?
Só endereços https são aceitos, endereços que resolvem dentro de uma rede privada são recusados, a busca sai sem cookie e o domínio de origem aparece antes de qualquer renderização. Domínio fora de uma lista curta de origens conhecidas espera a sua confirmação.