3.3 KiB
Dash contribution layer for Spacemacs
Description
This layer works only on OS X for the moment
- dash
- Is a great tool for quick access to various sets of documentation, only available in OS X.
- dash-at-point
- Is the package used to integrate
dashin Emacs. It will try to intelligently guess specific docsets to use based off of your current mode. - zeal
- Zeal is an offline documentation browser inspired by Dash, available for Linux and Windows.
- zeal-at-point
- Run zeal-at-point to search the word at point (or string in region), then Zeal is launched and search the word. Use prefix argument C-u to edit the search string first.
Install
To use this contribution add it to your ~/.spacemacs
(setq-default dotspacemacs-configuration-layers '(dash))Dash (OS X)
You have to install dash on your machine.
It is recommended to set the HUD mode in your Dash application preferences
when using this layer.
Zeal (Linux & Windows)
You have to install zeal on your machine.
Then install the docsets you use more frequently
Check Documentation for x-at-point
See the documentation dash-at-point-usage , or zeal-at-point for more information on customizing specific docsets for modes.
Key bindings
| Key Binding | Description |
|---|---|
SPC d d |
Lookup thing at point in Dash or Zeal |
SPC d D |
Lookup thing at point in Dash or Zeal within a specified Docset |
SPC d h |
Lookup thing at point in helm-dash |
SPC d H |
Lookup thing at point in helm-dash within a specified Docset |
helm-dash
dash-at-point is linked to the GUI app and is only available for OSX. On
linux, you can use zeal-at-point which is linked to the GUI app too, but it's
open source.
Or you can use helm-dash instead, it requires no app. You can use
dash/helm-dash-docset-newpath to set the location path of your docsets.
TODOs
DONE Check zeal
CLOSED: [2015-06-12 Fri 16:30] zeal is an open source alternative to dash with Emacs integration available.