DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.
The app’s main goals are to: keep load times as short as possible; improve the quality, speed, and order of search results; maximize the use of caching and other performance optimizations; maintain a clean and readable user interface; be fully functional offline; support full keyboard navigation; reduce “context switch” by using a consistent typography and design across all documentations; reduce clutter by focusing on a specific category of content (API/reference) and indexing only the minimum useful to most developers.
DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
DevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.
The web app is all client-side JavaScript, written in CoffeeScript, and powered by a small Sinatra/Sprockets application. It relies on files generated by the scraper.
The scraper is responsible for generating the documentation and index files (metadata) used by the app. It’s written in Ruby under the Docs module.
Website: github.com/freeCodeCamp/devdocs
Support:
Developer: Thibaut Courouble and contributors
License: Mozilla Public License Version 2.0
DevDocs is written in Ruby and CoffeeScript. Learn Ruby with our recommended free books and free tutorials. Learn CoffeeScript with our recommended free books and free tutorials.
Related Software
| API Documentation Browsers | |
|---|---|
| DevDocs | API documentation browser written in Ruby and JavaScript |
| Zeal | Simple offline documentation browser |
| Qt Assistant | Tool for viewing on-line documentation in Qt help file format |
| Biblioteca | Browse and read GNOME documentation |
| Devhelp | Developer tool for browsing and searching API documentation |
| dedoc | Terminal-based viewer for DevDoc |
| dasht | Search API docs offline in your terminal or browser |
| Ferritin | Terminal-based Rust documentation viewer |
| quickDocs | Developer docs reader |
| Doc Browser | API documentation browser with support for DevDocs, Dash and Hoogle |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.