{"repo":"freeCodeCamp/devdocs","free":true,"listed":false,"github":"https://github.com/freeCodeCamp/devdocs","clone":"git clone https://github.com/freeCodeCamp/devdocs.git","description":"API Documentation Browser","language":"Ruby","stars":39297,"topics":["devdocs","documentation","documentation-tool","developer-tools","docs","offline","app","api-documentation","pwa"],"license":"MPL-2.0","category":"docs-static-sites","readme_excerpt":"DevDocs — API Documentation Browser 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 was created by Thibaut Courouble and is operated by freeCodeCamp. We are currently searching for maintainers Please reach out to the community on Discord if you would like to join the team! Keep track of development news: Join the #contributors chat room on Discord Watch the repository on GitHub Table of Contents: Quick Start · Vision · App · Scraper · Commands · Contributing · Documentation · Related Projects · License · Questions? Quick Start Unless you wish to contribute to the project, we recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box. Using Docker (Recommended) The easiest way to run DevDocs locally is using Docker: This will start DevDocs at localhost:9292. We provide both regular and Alpine-based images: - ghcr.io/freecodecamp/devdocs:latest - Standard image - ghcr.io/freecodecamp/devdocs:latest-alpine - Alpine-based (smaller size) Images are automatically built and updated monthly with the latest documentation. Alternatively, you can build the image yourself: Manual Installation 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. DevDocs requires Ruby 4.0.6 (defined in Gemfile ), libcurl, and a JavaScript ","default_branch":null,"files":null,"tree":[],"storefront":"/r/freeCodeCamp","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/freeCodeCamp/devdocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}