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/+readers/dash/README.org
Maximilian Wolff 87ba29760a
[dash] Fix wrong keybindings in README
2020-04-17 23:43:42 +02:00

3.3 KiB
Raw Blame History

Dash layer

/TakeV/spacemacs/media/commit/4ad845cc39476be683241579dec25e92e1777805/layers/+readers/dash/img/dash.png

/TakeV/spacemacs/media/commit/4ad845cc39476be683241579dec25e92e1777805/layers/+readers/dash/img/zeal.png

Description

This layer integrates offline API browsers into Emacs. It provides one for macOS, Linux and Windows.

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 dash offline API browser for macOS.
  • Support for zeal offline API browser for Linux.

Install

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 file.

Dash (macOS)

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.

Sqlite3

Helm Dash requires sqlite3 to be installed to function properly.

Zeal (Linux & Windows)

You have to install zeal on your machine.

Then install the docsets you use more frequently

Configuration

By default, the dash layer will initialize all installed docsets to be active in all buffers. To disable this and opt-in to specific docsets for specific buffers, set:

  (dash :variables
        dash-autoload-common-docsets nil)

To change the location of the installed docsets, set:

  (dash :variables
        helm-dash-docset-newpath "~/.docsets")

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 helm-dash can be used for helm and counsel-dash for ivy.

To get them working it is necessary to set dash-docs-docset-newpath to the location of your docsets.

  (dash :variables
        dash-docs-docset-newpath "~/.local/share/Zeal/Zeal/docsets")

For more details please check dash-at-point-usage or zeal-at-point.

Key bindings

Key binding Description
SPC a z d Lookup thing at point in Dash or Zeal
SPC a z D Lookup thing at point in Dash or Zeal within a specified Docset
SPC a z h Lookup thing at point in helm-dash or counsel-dash
SPC a z H Lookup in helm-dash or counsel-dash within a specified Docset