#Devdocs vs dash install
#Devdocs vs dash update
#Devdocs vs dash full
#Devdocs vs dash code
#Devdocs vs dash windows

removing content such as the document structure (, , etc.), comments, empty nodes, etc.Modifications made to each document include: They both make copies of HTML documents, recursively following links that match a set of rules and applying all sorts of modifications along the way, in addition to building an index of the files and their metadata. There are currently two kinds of scrapers: UrlScraper which downloads files via HTTP and FileScraper which reads them from the local filesystem. 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 vs dash 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.

#Devdocs vs dash full

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 VisionĭevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. To stay informed about new releases, be sure to watch this repository.Īlternatively, DevDocs may be started as a Docker container:ĭocker build -t thibaut/devdocs.

#Devdocs vs dash update

Note: there is currently no update mechanism other than git pull origin main to update the code and thor docs:download -installed to download the latest version of the docs.

#Devdocs vs dash install

To download and install all documentation this project has available, run thor docs:download -all. To update all downloaded documentations, run thor docs:download -installed. You can see the list of available documentations and versions by running thor docs:list. The thor docs:download command is used to download pre-generated documentations from DevDocs's servers (e.g. Once you have these installed, run the following commands:įinally, point your browser at localhost:9292 (the first request will take a few seconds to compile the assets).

#Devdocs vs dash windows

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.