Skip to content

dimitry-ishenko-cpp/devdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

devdocs + fzf + elinks = ☯

What happens when you combine devdocs API documentation, fzf fuzzy finder and elinks text-based browser?

Installation

Binary

Debian/Ubuntu/etc:

$ sudo add-apt-repository ppa:ppa-verse/dev
$ sudo apt install devdocs
$ apt list devdocs-data-*
$ # find doc packages you are interested in and install them as well, eg:
$ sudo apt install devdocs-data-css devdocs-data-html

RaspberryPi:

$ sudo add-apt-repository -S deb https://ppa.launchpadcontent.net/ppa-verse/dev/ubuntu jammy main
$ sudo apt install devdocs
# install doc packages as above

From source

Stable version (requires CMake >= 3.16, elinks >= 0.17.1, fzf, python3 with Pygments and lxml).

$ p=devdocs v=1.1
$ wget https://github.com/dimitry-ishenko-cpp/${p}/archive/v${v}.tar.gz
$ tar xzf v${v}.tar.gz
$ mkdir ${p}-${v}/build
$ cd ${p}-${v}/build
$ cmake ..
$ make
$ make install

To install system-wide, change the last 3 commands above to:

$ cmake -DSYSTEM_INSTALL=ON ..
$ make
$ sudo make install

Authors

  • Dimitry Ishenko - dimitry (dot) ishenko (at) (gee) mail (dot) com

License

This project is distributed under the GNU GPL license. See the LICENSE.md file for details.

Acknowledgments

Share and enjoy.