Note: DevDocs is neither a programming guide nor a search engine. 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. # Finally, start a DevDocs container (access docker run -name devdocs -d -p 9292:9292 thibaut/devdocsĭevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. Once you have these installed, run the following commands: It’s up-to-date and works offline out-of-the-box.ĭevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.ĭevDocs requires Ruby 2.6.x, libcurl, and a JavaScript runtime supported by ExecJS (included in OS X and Windows Node.js on Linux). Unless you wish to contribute to the project, we recommend using the hosted version at devdocs.io. Join the contributor chat room on Gitter.Devdocs DevDocs - API Documentation BrowserĭevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.ĭevDocs was created by Thibaut Courouble and is operated by freeCodeCamp.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |