DevDocs is a fast, offline-capable API documentation browser that consolidates multiple developer references into a clean, searchable web interface.
API Documentation Browser
DevDocs is designed for developers who need quick and easy access to multiple API documentations in one place, both online and offline. It is ideal for improving productivity by reducing context switching and enabling instant search across various programming languages and technologies.
DevDocs requires Ruby 3.4.1, libcurl, and a JavaScript runtime supported by ExecJS (Node.js recommended on Linux). There is no automated update mechanism for the codebase aside from manual git pulls, so users should regularly update the repository and documentation sets. Docker images are updated monthly for convenience.
Clone the repository: git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
Install Ruby dependencies: gem install bundler
Install project gems: bundle install
Download default documentation: bundle exec thor docs:download --default
Run the app locally: bundle exec rackup
Access the app at http://localhost:9292
Alternatively, run using Docker: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latestdocker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest
Starts the DevDocs application locally using the official Docker image.
bundle exec thor docs:download --default
Downloads the default set of pre-generated documentation from DevDocs servers.
bundle exec thor docs:list
Lists all available documentations and their versions.
bundle exec thor docs:download --installed
Updates all downloaded documentations to their latest versions.
bundle exec thor docs:download --all
Downloads and installs all available documentation sets.
bundle exec rackup
Runs the DevDocs web application locally.