#Devdocs wikipedia code#
#Devdocs wikipedia Offline#

It's written in Ruby under the Docs module. The scraper is responsible for generating the documentation and index files (metadata) used by the app.

#Devdocs wikipedia code#

This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun! Scraper

Recent versions of Firefox, Chrome, or Opera.

The search algorithm is kept simple because it needs to be fast even searching through 100,000 strings.ĭevDocs being a developer tool, the browser requirements are high: A service worker (which comes with its own set of constraints) and localStorage are used to speed up the boot time, while memory consumption is kept in check by allowing the user to pick his/her own set of documentations. scripts and stylesheets) to avoid polluting the main frame, and prefixing all CSS class names with an underscore to prevent conflicts.Īnother driving factor is performance and the fact that everything happens in the browser. This includes stripping the original documents of most of their HTML markup (e.g. Many of the code's design decisions were driven by the fact that the app uses XHR to load content directly into the main frame. It relies on files generated by the scraper. The web app is all client-side JavaScript, written in CoffeeScript, and powered by a small Sinatra/ Sprockets application. Tutorials, guides and other content that don't meet this requirement are outside the scope of the project. Its backbone is metadata each piece of content is identified by a unique, 'obvious' and short string. All our content is pulled from third-party sources and the project doesn't intend to compete with full-text search engines.

Note: DevDocs is neither a programming guide nor a search engine.

Reduce clutter by focusing on a specific category of content (API/reference) and indexing only the minimum useful to most developers.

Reduce “context switch” by using a consistent typography and design across all documentations.Maintain a clean and readable user interface.Maximize the use of caching and other performance optimizations.Improve the quality, speed, and order of search results.Once you have these installed, run the following commands:ĭevDocs aims to make reading and searching reference documentation fast, easy and enjoyable.

#Devdocs wikipedia Offline#

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.7.4, 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. Please reach out to the community on Discord if you would like to join the team! We are currently searching for maintainers 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.ĭevDocs was created by Thibaut Courouble and is operated by freeCodeCamp.