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). 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 Give them a try and if you know of another tool share it in the comments.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. In fact, I was using the Markdown cheatsheet on Dash while writing this very post. Using an offline documentation tool can be super convenient. Searching documentation functions very similar to Dash but its fuzzy search capabilities can sometimes be an annoyance. Just like with Dash you can search and download documentation in a simple and easy manner. It only offers offline documentation for most of the popular language/libraries/frameworks, no cheatsheets or code snippet support. I would best describe Zeal as a stripped-down version of Dash. Zeal is an offline documentation browser for software developers. You can find and edit them in Preferences > Docsets Most docsets already come with a defined keyword, typically the name of the language/library/framework. If you look a little closer on the bottom left margin it will also display all the methods on the class, cool. We now scoped our results to only search Ruby and then look for class and/or method we are looking for. That is easy to do if you know docset keyword. But this is super noisy and we know we just want to search Ruby for a find method on the Array class. You can see in the left top margin results for Array find across all the different language/frameworks/cheatsheets. Pulling up documentation is fairly simple, in the top left you can either do a generic search that will scan all the documentation you have downloaded. You can see a lot of different documentation downloaded on the left margin and my downloaded cheatsheets are hidden under the fold. Dash is free to use but comes with nag modal asking to you purchase it but the paid version comes with awesome integration features for Alfred and most code editors/IDEs. The extra bonus is that it also has a good library of cheat sheets to quickly lookup how to do something. It has access to documentation for almost all major languages/frameworks/libraries you might work with. You can even generate your own docsets or request docsets to be included.ĭash is such an awesome tool to use and recommend it to everyone I work with. Dash stores snippets of code and instantly searches offline documentation sets for 200+ APIs, 100+ cheat sheets and more. Let me introduce you to the tools I used when developing on macOS and Windows 10ĭash is an API Documentation Browser and Code Snippet Manager. No need to load any webpages, parse through results, just go straight to the source. Look at available Array methods or search for anything mentioning find.Then wait for the results to come back and click on the website of your choice where you might find some documentation.I knew it was just called find in JavaScript but for the life of me, I couldn't remember if there was a nice and clean method in Ruby to do this. In a recent situation, I couldn't remember how you would perform a find on an Array in Ruby. That's a lot of information to keep at the top of your mind and I sometimes forget which methods are available in Ruby vs JavaScript. If you are like myself, any given day you can be programming in more than one language (Ruby and JavaScript in my case), maybe you use a UI framework (Bootstrap), and let's throw in a frontend framework (React). Offline documentation tools are one of those tools you didn't know you needed until you try it. TLDR: Try Dash on macOS and Zeal on Window/Linux Today I would like to introduce you to offline documentation tools I use on macOS and Windows. This will be the first in an ongoing series of posts sharing the tools, workflows and IDE setup I use in my daily development.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |