# DevDocs — Fast All-in-One API Documentation Browser

> A free web app that combines documentation for hundreds of developer APIs and languages in a fast, searchable, offline-capable interface.

## Install

Save as a script file and run:

# DevDocs — Fast All-in-One API Documentation Browser

## Quick Use
```bash
# Use the hosted version at devdocs.io

# Or self-host with Docker
docker run -d -p 9292:9292 ghcr.io/nicholasgasior/devdocs

# Enable offline mode in the browser for use without internet
```

## Introduction
DevDocs aggregates API documentation for over 400 programming languages, frameworks, and tools into a single searchable interface. It loads instantly, works offline via Service Workers, and supports keyboard-driven navigation, making it one of the fastest ways to look up developer documentation.

## What DevDocs Does
- Combines documentation from 400+ sources into a unified, searchable interface
- Supports instant fuzzy search across all enabled documentation sets
- Works offline after initial download via browser Service Workers
- Provides keyboard-first navigation with shortcut keys for power users
- Allows selecting only the documentation sets you need to reduce clutter

## Architecture Overview
DevDocs is a Ruby on Rails application that scrapes and normalizes documentation from upstream sources into a consistent HTML format. Each documentation set is defined by a scraper class and stored as preprocessed JSON. The frontend is a single-page application built with vanilla JavaScript that loads documentation entries on demand and indexes them for instant search.

## Self-Hosting & Configuration
- Visit devdocs.io to use the hosted version with no setup required
- Click the gear icon to enable or disable individual documentation sets
- Toggle offline mode in Preferences to cache all enabled docs in the browser
- For self-hosting, clone the repo and run `bundle install && thor docs:download --all && rackup`
- Docker images are available for containerized deployment

## Key Features
- Instant fuzzy search that filters results as you type
- Offline support lets you browse docs without an internet connection
- Dark and light themes with customizable appearance
- Mobile-responsive layout for documentation on the go
- Open source with community-contributed documentation scrapers

## Comparison with Similar Tools
- **Zeal** — offline desktop app inspired by Dash; DevDocs is browser-based and requires no installation
- **Dash (macOS)** — native Mac app with snippet manager; proprietary and macOS-only
- **docs.rs** — Rust-specific documentation; DevDocs covers 400+ technologies
- **MDN Web Docs** — authoritative for web APIs; DevDocs aggregates MDN alongside hundreds of other sources
- **tldr-pages** — provides simplified command examples; DevDocs offers full API reference documentation

## FAQ
**Q: Is DevDocs free?**
A: Yes. DevDocs is fully free and open source under the MPL-2.0 license.

**Q: How current is the documentation?**
A: Documentation sets are updated regularly by automated scrapers that pull from upstream sources.

**Q: Can I add documentation for a custom library?**
A: Yes. You can write a custom scraper following the contribution guide to add new documentation sources.

**Q: Does DevDocs work on mobile?**
A: Yes. The interface is responsive and works in mobile browsers, including offline mode.

## Sources
- https://github.com/freeCodeCamp/devdocs
- https://devdocs.io/

---
Source: https://tokrepo.com/en/workflows/8d2383c7-4384-11f1-9bc6-00163e2b0d79
Author: Script Depot