Hysen Labsdevdocs
API Documentation Browser
DevDocs: every reference doc, one search box
DevDocs pulls multiple API references into a single clean interface with instant search, offline use, keyboard shortcuts, and a dark theme. The README details the Ruby scraper and JavaScript app behind it, plus a Docker path to run it locally.
One window for many docs
DevDocs combines multiple developer documentations in a clean web interface with instant search, offline support, a mobile version, a dark theme, and keyboard shortcuts. The README recommends the hosted version at devdocs.io for anyone not planning to contribute, calling it up to date and ready to work offline out of the box. The license is MPL-2.0.
A deliberately narrow vision
The vision section is explicit about what DevDocs will not do. It is not a programming guide and not a search engine, and it does not intend to compete with full-text search. Every piece of content must be identified by a unique, short string, which pushes tutorials and guides out of scope. The goals listed are load times, search quality, caching, a clean interface, offline function, and full keyboard navigation.
How the pieces fit
The project is two pieces: a Ruby scraper that generates the documentation and its metadata, and a JavaScript app served by a small Sinatra application. Two kinds of scrapers exist, one fetching over HTTP and one reading from the local filesystem, both processing pages through filters built with HTML::Pipeline and parsing documents with Nokogiri. The app runs entirely client side, using a service worker and localStorage to speed up startup.
Running and extending it
Docker is the recommended local route, with standard and Alpine images that start DevDocs at localhost:9292. Manual installation asks for Ruby, libcurl, and a JavaScript runtime, and the thor command handles downloads: docs:list to see what is available, docs:download to fetch specific sets. A cheatsheet in the README covers the search shortcuts, and a table of related projects points to editor plugins and viewers. The project also notes it is looking for maintainers.
Editorial conclusion
The project's limits are deliberate: reference material only, no tutorials, no full-text search competition. Right now the README asks for maintainers, which makes it a project worth watching for contributors as much as for users.
Community notes