Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skeeto/devdocs-lookup

Quick Emacs API lookup on devdocs.io
https://github.com/skeeto/devdocs-lookup

Last synced: about 2 months ago
JSON representation

Quick Emacs API lookup on devdocs.io

Awesome Lists containing this project

README

        

# Emacs devdocs-lookup

This package provides an interactive function `devdocs-lookup` to
quickly jump to documentation on a particular API at
[devdocs.io](http://devdocs.io/) with your browser. It works similarly
to [javadoc-lookup](https://github.com/skeeto/javadoc-lookup), using
your locally-configured `completing-read` to select an entry.

The currently supported "subjects" are the same as devdocs.io.

## Optional Configuration

To bypass indicating the subject on each lookup, devdocs-lookup can
generate interactive commands for each of the individual subjects by
calling `devdocs-setup`. Your Emacs initialization file might contain
the following snippet.

~~~el
(devdocs-setup)
(global-set-key (kbd "C-h C-c") #'devdocs-lookup-c)
(global-set-key (kbd "C-h C-p") #'devdocs-lookup-python)
(global-set-key (kbd "C-h C-=") #'devdocs-lookup-cpp)
~~~