Update notifier, it checks for new release everyday Initially you're browsing web content on devdocs.io, but an Offline feature enable downloading some or all of the sections. Or just use the fuzzy search feature to find all potential matches. Expand something like HTTP, select an interesting section such as Status and click a code to find out what it means. You can browse them much like any other web-based manual. Click "Select documentation" bottom-left, check the boxes next to anything you need, click Save and the new technologies are collected together at the top of the sidebar. The app has support for C, C++, CoffeeScript, CSS, DOM, Git, HTML, HTTP headers and status codes, JavaScript, jQuery, Markdown, PHP, Python, React, Ruby, SVG and more (there are around 200 virtual manuals in total).Īll the available documentations are listed in a left-hand sidebar. People have already created plugins for Sublime Text and Brackets.DevDocs is an Electron-based application which enables offline documentation browsing for many web and other development technologies. I'd like to create an offline-enabled version that works out-of-the-box (currently you have to download the code to use DevDocs offline) as well as smartphone/PhoneGap apps (the current app is already optimized for mobile but native apps would bundle the docs for offline reading).įurther down the road we could imagine deep integrations with IDEs. Speed and ease of use are my top priorities, so I have many ideas about optimizations and UI tweaks. Part of my plans can be tracked on GitHub. The future plans for the site can usually be tracked on GitHub, says Thibaut: The only requirements are a few "quality guidelines" and that the doc's license allows redistribution of modified versions (which Microsoft, Apple and Oracle prohibit).Īs for choosing which documentations to work on myself, votes are definitely a major factor, personal preference another (though I've now added most of the ones I want), and also how organized the original docs are (i.e. Much work went into creating a flexible scraper/toolchain that helps with adding new docs and maintaining the existing ones. There is also a voting system in place to request new documentation sets, although anyone can contribute, as explained by Thibaut:Īnyone is welcome to contribute new documentations. If I miss a release, DevDocs's users are welcome to request an update on our Trello board".ĭevDocs has been open sourced and welcomes contributors. Thibaut asserts "the existing documentations are updated often, usually within a few days of a new version being released. Since all the documentation published on DevDocs is scrapped, the update process is not instantaneous. The DevDoc's HTML home page is an illustrative example of what DevDocs looks like: Thibaut Courouble, DevDocs' creator, told InfoQ that additional documentation sets are on the pipeline: "I recently started working on the Linux man pages, with Bash, C, C++, D3.js and Knockout.js also on my short-term todo list". The app's main goals are to: keep booting and loading 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, readable user interface support full keyboard navigation reduce "context switch" by using a consistent typography and design across all documentation sets reduce clutter by focusing on a specific category of content (API/reference) and by indexing only the minimum useful to most developers.ĭevDocs currently offers documentation mainly targeted for web development including: standards (e.g.: HTML, HTTP, CSS) languages (e.g.: Ruby, Python, JavaScript) libraries (e.g.: jQuery, Ember) and products (e.g.: Ruby on Rails, PostgreSQL, Redis, Git). DevDocs takes advantage of this centralization to offer crosscutting features to all the APIs such as a searchable interface, keyboard shortcuts, common layouts or a common table of contents.Īccording to DevDoc's vision statement: DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. DevDocs combines multiple reference documentation sets, commonly used by software developers, in a single web site.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |