Zeal: Offline documentation at hand

I was reading on Humans an article related to Zeal, an application that allows us to have documentation on various applications, frameworks and its APIs in a offline, and I wanted to share with you how the available documentation is installed and added.

What is Zeal?

Zeal is an alternative to Dash, its counterpart in OS X already Velocity, its counterpart in Windows. In fact, use the same listing de docset, which is how they call the available documentation.

How do we install Zeal?

On its download page we can find several ways to install Zeal depending on the distribution. In the case of Ubuntu:

add-apt-repository ppa: jerzy-kozera / zeal-ppa apt-get update apt-get install zeal

For ArchLinux installs from AUR:

yaourt -S zeal-git

There are packages for Gentoo y openSUSE, but for Fedora you have to compile it from Zeal source. Once installed we just have to run it from the start menu, or from a terminal.

How do we import the Docsets into Zeal?

Once the application is open we will Fillet (Archive) " Options (Options) » docsets. Zeal will load the list with the available documentation and we will only have to select the one we want and download it from the same window.

We can close the options window while the documentation is being downloaded, and the entries that we marked once they are downloaded will appear on the left side in the main window.

Now we can navigate through each section of the downloaded documentation or insert some search criteria (in general or using a prefix) to show us the results for each docset Discharged:

To all this we add that Zeal can be integrated with some of the most popular text editors such as Sublime Text, brackets, Vim o Emacs.

As the boys of Humans, you can create your own documentation and put it inside the folder where our docsets to be able to view it. Many programs we use to generate documentation allow creating docset, such is the case of javadoc, Appledoc, Sphinx o pydoctor, RDoc o Yard, Doxygen, among others. You can also bring documentation HTML a docset, following the guide that is exposed here.

And that's it.