Repolode
Submit
freeCodeCamp

freeCodeCamp/devdocs

A web-based API documentation browser that combines many developer reference docs into one searchable, offline-capable interface.

Open-source alternative to:Dash

View on GitHubWebsite
Stars
39,565
Forks
2,655
Open issues
201
Last commit
yesterday

What is it?

DevDocs brings together reference documentation from many programming languages, frameworks and tools into a single web interface with instant search, keyboard shortcuts, a dark theme and a mobile-friendly layout. Users choose which documentation sets to install, so the app only loads what they need.

The app runs entirely in the browser and can work offline after docs are downloaded. Its backend is a Ruby scraper that generates normalized HTML and search index files from upstream sources, plus a small Sinatra server. The project can be run with Docker or installed manually with Ruby, and the `thor` CLI handles downloading, generating and packaging documentation sets.

The project focuses on API and reference content rather than tutorials, and it is operated by freeCodeCamp. Contributors can add new documentation sets through the scraper and filter system described in the project's docs.

Key features

  • 01Searches across many installed documentation sets instantly.
  • 02Works offline after documentation is downloaded.
  • 03Supports full keyboard navigation and a dark theme.
  • 04Runs via Docker or a manual Ruby setup.
  • 05Includes a Thor CLI for downloading, generating and packaging docs.

Use cases

  • Looking up language or framework API references without leaving the browser.
  • Reading documentation offline while travelling or on unreliable connections.
  • Running a private, self-hosted documentation browser with Docker.
  • Building or maintaining a custom documentation set for internal use.

Quick start

  1. 1

    Run DevDocs locally with Docker

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

Things to know

  • The project is currently looking for maintainers, so long-term upkeep is uncertain.
  • Manual installation requires Ruby 4.0.7, libcurl, bsdtar and a JavaScript runtime, and the documentation sets must be downloaded separately.

Topics

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

FAQ

What is devdocs?
A web-based API documentation browser that combines many developer reference docs into one searchable, offline-capable interface. DevDocs brings together reference documentation from many programming languages, frameworks and tools into a single web interface with instant search, keyboard shortcuts, a dark theme and a mobile-friendly layout. Users choose which documentation sets to install, so the app only loads what they need.
Is devdocs free to use? What license does it have?
devdocs is open source under the MPL-2.0 license. Check the license terms before using it in commercial products.
Is devdocs still maintained?
Actively maintained. The last commit to devdocs was on Oct 21, 2026.
What can I use devdocs for?
Looking up language or framework API references without leaving the browser. Reading documentation offline while travelling or on unreliable connections. Running a private, self-hosted documentation browser with Docker. Building or maintaining a custom documentation set for internal use.
How do I install devdocs?
Run DevDocs locally with Docker: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
Where can I get devdocs?
The source code and installation instructions are on GitHub: https://github.com/freeCodeCamp/devdocs

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects