TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+tools/dash
History
justbur 9befd20a1a layers: Transition to new key bindings functions 
Removes dependence on evil-leader centralizing control over the method
of key binding in core-keybindings.el
2015-11-21 18:22:51 +01:00
..
img
config.el
packages.el layers: Transition to new key bindings functions 2015-11-21 18:22:51 +01:00
README.org Documentation update 2015-11-13 14:23:13 +01:00

README.org

Dash contribution layer for Spacemacs

/TakeV/spacemacs/media/commit/fb62086b348e39c21480c0353c39ed87b25c6ade/layers/+tools/dash/img/dash.png

/TakeV/spacemacs/media/commit/fb62086b348e39c21480c0353c39ed87b25c6ade/layers/+tools/dash/img/zeal.png

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 dash in 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.

TODO Make helm-dash use zeal or dash docsets by default.