2015-12-02 14:23:39 +00:00
#+TITLE : Dash layer
2015-11-08 18:04:44 +00:00
2015-06-10 16:44:30 +00:00
[[file:img/dash.png ]]
2015-06-12 20:59:07 +00:00
[[file:img/zeal.png ]]
2016-03-31 02:59:55 +00:00
* Table of Contents :TOC_4_gh:noexport:
2017-05-22 14:16:12 +00:00
- [[#description ][Description ]]
2018-01-07 22:26:54 +00:00
- [[#features ][Features: ]]
2017-05-22 14:16:12 +00:00
- [[#install ][Install ]]
- [[#dash-os-x ][Dash (OS X) ]]
2018-01-07 22:26:54 +00:00
- [[#sqlite3 ][Sqlite3 ]]
2017-05-22 14:16:12 +00:00
- [[#zeal-linux--windows ][Zeal (Linux & Windows) ]]
2018-01-07 22:26:54 +00:00
- [[#word-at-point ][Word at point ]]
2017-05-22 14:16:12 +00:00
- [[#key-bindings ][Key bindings ]]
2015-06-10 16:44:30 +00:00
* Description
2018-01-07 22:26:54 +00:00
This layer integrates offline api browsers into emacs. It provides one for OS X, Linux and Windows.
2015-06-12 20:59:07 +00:00
2018-01-07 22:26:54 +00:00
** Features:
- Searching for word at point in offline api browser's UI.
- Integration of offline api browser search results in helm and ivy.
- Support for [[https://kapeli.com/dash ][dash ]] offline api browser for OS X.
- Support for [[https://zealdocs.org/ ][zeal ]] offline api browser for Linux.
2015-06-10 16:44:30 +00:00
* Install
2016-01-06 05:21:55 +00:00
To use this configuration layer, add it to your =~/.spacemacs= . You will need to
add =dash= to the existing =dotspacemacs-configuration-layers= list in this
2016-11-21 23:32:00 +00:00
file.
2015-06-10 16:44:30 +00:00
2015-06-12 20:59:07 +00:00
** Dash (OS X)
2017-04-25 15:42:58 +00:00
You have to install [[https://kapeli.com/dash ][dash ]] on your machine.
2015-06-10 16:44:30 +00:00
It is recommended to set the =HUD mode= in your Dash application preferences
2016-04-13 03:31:38 +00:00
when using this layer.
2015-06-10 16:44:30 +00:00
2018-01-07 22:26:54 +00:00
*** Sqlite3
2017-04-25 15:42:58 +00:00
Helm Dash [[https://github.com/areina/helm-dash#user-content-requirements ][requires ]] sqlite3 to be installed to function properly.
2016-10-20 16:36:39 +00:00
2015-06-12 20:59:07 +00:00
** Zeal (Linux & Windows)
2017-04-25 15:42:58 +00:00
You have to install [[https://zealdocs.org/ ][zeal ]] on your machine.
2015-06-12 20:59:07 +00:00
Then install the docsets you use more frequently
2018-01-07 22:26:54 +00:00
* Word at point
=dash-at-point= and =zeal-at-point= will search for the word at point in the respective offline api browser.
The result will be displayed in the offline browser's UI.
However having to leave emacs to have a look at the search results may be a bit awkward.
To help with this it is also possible to integrate the search results directly in =helm= or =ivy=
and show the details in a browser. To do so [[https://github.com/areina/helm-dash ][helm-dash ]] can be used for =helm= and [[https://github.com/nathankot/counsel-dash ][counsel-dash ]] for =ivy= .
To get them working it is necessary to set =helm-dash-docset-newpath= to the location of your docsets.
#+BEGIN_SRC elisp
(dash :variables
helm-dash-docset-newpath "~/.local/share/Zeal/Zeal/docsets")
#+END_SRC
For more details please check [[https://github.com/stanaka/dash-at-point#Usage ][dash-at-point-usage ]] or [[https://github.com/jinzhu/zeal-at-point ][zeal-at-point ]].
2015-06-10 16:44:30 +00:00
* Key bindings
2015-06-12 20:59:07 +00:00
| 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 |
2016-06-20 07:13:20 +00:00
| ~SPC d h~ | Lookup thing at point in helm-dash or counsel-dash |
| ~SPC d H~ | Lookup in helm-dash or counsel-dash within a specified Docset |
