Repolode
Enviar
freeCodeCamp

freeCodeCamp/devdocs

Um navegador web de documentação de APIs que reúne referências para desenvolvedores em uma interface pesquisável e disponível offline.

Alternativa open source a:Dash

Ver no GitHubSite
Estrelas
39,565
Forks
2,655
Issues abertas
201
Último commit
ontem

O que é?

O DevDocs reúne documentação de referência de várias linguagens de programação, frameworks e ferramentas em uma única interface web, com busca instantânea, atalhos de teclado, tema escuro e layout adaptado para dispositivos móveis. Os usuários escolhem quais conjuntos de documentação instalar, então o app carrega apenas o que precisam.

O app funciona inteiramente no navegador e pode ser usado offline depois que a documentação é baixada. O backend é um scraper em Ruby que gera arquivos HTML normalizados e índices de busca a partir de fontes upstream, além de um pequeno servidor Sinatra. O projeto pode ser executado com Docker ou instalado manualmente com Ruby, e a CLI `thor` cuida do download, da geração e do empacotamento dos conjuntos de documentação.

O projeto prioriza conteúdo de API e referência, em vez de tutoriais, e é mantido pelo freeCodeCamp. Contribuidores podem adicionar novos conjuntos de documentação por meio do scraper e do sistema de filtros descritos na documentação do projeto.

Recursos principais

  • 01Pesquisa instantaneamente em vários conjuntos de documentação instalados.
  • 02Funciona offline depois que a documentação é baixada.
  • 03Oferece navegação completa pelo teclado e tema escuro.
  • 04Pode ser executado com Docker ou instalado manualmente com Ruby.
  • 05Inclui uma CLI Thor para baixar, gerar e empacotar documentação.

Casos de uso

  • Consultar referências de APIs de linguagens ou frameworks sem sair do navegador.
  • Ler documentação offline durante viagens ou em conexões instáveis.
  • Executar um navegador de documentação privado e auto-hospedado com Docker.
  • Criar ou manter um conjunto de documentação personalizado para uso interno.

Início rápido

  1. 1

    Executar o DevDocs localmente com Docker

    docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

Antes de usar

  • O projeto está procurando mantenedores, por isso a manutenção a longo prazo é incerta.
  • A instalação manual requer Ruby 4.0.7, libcurl, bsdtar e um ambiente de execução JavaScript; além disso, os conjuntos de documentação precisam ser baixados separadamente.

Tópicos

#api-documentation#documentation#offline#developer-tools#ruby#pwa#app#devdocs#docs#documentation-tool

Perguntas frequentes

O que é devdocs?
Um navegador web de documentação de APIs que reúne referências para desenvolvedores em uma interface pesquisável e disponível offline. O DevDocs reúne documentação de referência de várias linguagens de programação, frameworks e ferramentas em uma única interface web, com busca instantânea, atalhos de teclado, tema escuro e layout adaptado para dispositivos móveis. Os usuários escolhem quais conjuntos de documentação instalar, então o app carrega apenas o que precisam.
devdocs é gratuito? Qual é a licença?
devdocs é open source sob a licença MPL-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
devdocs ainda é mantido?
Manutenção ativa. O último commit de devdocs foi em 21 de out. de 2026.
Para que posso usar devdocs?
Consultar referências de APIs de linguagens ou frameworks sem sair do navegador. Ler documentação offline durante viagens ou em conexões instáveis. Executar um navegador de documentação privado e auto-hospedado com Docker. Criar ou manter um conjunto de documentação personalizado para uso interno.
Como instalar devdocs?
Executar o DevDocs localmente com Docker: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
Onde consigo devdocs?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/freeCodeCamp/devdocs

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados