Browse Dash docsets using Ivy
Emacs Lisp
Switch branches/tags
Clone or download
Latest commit 07fa74a Jul 29, 2016
Permalink
Failed to load latest commit information.
LICENSE Add LICENSE and README May 24, 2016
README.md Add MELPA installation instructions May 24, 2016
counsel-dash.el Fix counsel-dash Jul 28, 2016

README.md

counsel-dash

Melpa Status

Browse Dash docsets using Ivy.

Installation

MELPA

M-x package-install RET counsel-dash RET

Source

Make sure counsel-dash.el is in your load-path and then:

(require 'counsel-dash)

How it works

This is a simple wrapper around helm-dash, of which you should check out for implementation details.

Unfortunately helm-dash depends on helm, so this package also implicitly depends on helm - even though helm isn't really necessary. In the future, helm-dash may be decoupled into a separate library that provides dash capabilities only. At that point we will switch over to the new library - the API will remain unchanged.

Configuration

You'll find most of the available functions and configuration variables are exactly the same as helm-dash with a different prefix (s/helm-dash/counsel-dash/.) This is because they are simply aliases to the helm-dash equivalents.

Install docsets

M-x counsel-dash-install-docset

Setup default docsets

(setq counsel-dash-common-docsets '("Javascript" "HTML"))

Setup mode-specific docsets

(add-hook 'emacs-lisp-mode-hook (lambda () (setq-local counsel-dash-docsets '("Emacs Lisp"))))
(add-hook 'ruby-mode-hook (lambda () (setq-local counsel-dash-docsets '("Ruby"))))

Other options

(setq counsel-dash-docsets-path "~/.docset")
(setq counsel-dash-docsets-url "https://raw.github.com/Kapeli/feeds/master")
(setq counsel-dash-min-length 3)
(setq counsel-dash-candidate-format "%d %n (%t)")
(setq counsel-dash-enable-debugging nil)
(setq counsel-dash-browser-func 'browse-url)
(setq counsel-dash-ignored-docsets nil)

Usage

M-x counsel-dash

License

See LICENSE