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/+emacs/helpful/README.org

50 lines
2.1 KiB
Org Mode
Raw Normal View History

Add helpful layer
2017-12-13 17:22:54 +00:00
#+TITLE: helpful layer
Tag uncategorized layers
2019-12-28 08:57:57 +00:00
#+TAGS: emacs|layer
documentation formatting: Mon Dec 9 21:44:48 UTC 2019
2019-12-09 21:44:48 +00:00
* Table of Contents :TOC_5_gh:noexport:
Add helpful layer
2017-12-13 17:22:54 +00:00
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
[helpful] Bindings and documentation improvements New bindings: `gr` - `helpful-update`, reload helpful buffer. `SPC m q` - `helpful-kill-buffers`, kill all helpful buffers. Move `o` binding definition into separate post-init function, so the binding is defined only if the `link-hint` package is actually installed. Add documentation of the added bindings.
2020-03-23 20:03:08 +00:00
- [[#global-bindings][Global bindings]]
- [[#helpful-mode-bindings][Helpful mode bindings]]
Add helpful layer
2017-12-13 17:22:54 +00:00
* Description
Make helpful layer replace existing emacs help functions The helpful layer delivers more sophisticated help buffers, at least for elisp and emacs specific objects. Therefore it makes sense to replace the existing help functions for these bindings silently if this layer is loaded.
2019-12-07 00:42:55 +00:00
This layer replaces the existing emacs related help buffers with more detailed ones.
Add helpful layer
2017-12-13 17:22:54 +00:00
** Features:
Make helpful layer replace existing emacs help functions The helpful layer delivers more sophisticated help buffers, at least for elisp and emacs specific objects. Therefore it makes sense to replace the existing help functions for these bindings silently if this layer is loaded.
2019-12-07 00:42:55 +00:00
- Better help buffers with [[https://github.com/Wilfred/helpful][helpful]] for emacs related buffers
- Source code shown implicitly in help buffer for all lisp objects
- More detailed descriptions in the emacs specific function, variable and key help buffers
- Better formatted elisp docstrings
Add helpful layer
2017-12-13 17:22:54 +00:00
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =helpful= to the existing =dotspacemacs-configuration-layers= list in this
file.
* Key bindings
[helpful] Bindings and documentation improvements New bindings: `gr` - `helpful-update`, reload helpful buffer. `SPC m q` - `helpful-kill-buffers`, kill all helpful buffers. Move `o` binding definition into separate post-init function, so the binding is defined only if the `link-hint` package is actually installed. Add documentation of the added bindings.
2020-03-23 20:03:08 +00:00
** Global bindings
Make helpful layer replace existing emacs help functions The helpful layer delivers more sophisticated help buffers, at least for elisp and emacs specific objects. Therefore it makes sense to replace the existing help functions for these bindings silently if this layer is loaded.
2019-12-07 00:42:55 +00:00
This layer aims to silently replace the standard emacs help key bindings
with improved versions. So it does not introduce new bindings.
For the sake of completion you can find below all keys which are replaced
by this layer.
Add helpful layer
2017-12-13 17:22:54 +00:00
documentation formatting: Mon Dec 9 21:44:48 UTC 2019
2019-12-09 21:44:48 +00:00
| Key binding | Description |
Make helpful layer replace existing emacs help functions The helpful layer delivers more sophisticated help buffers, at least for elisp and emacs specific objects. Therefore it makes sense to replace the existing help functions for these bindings silently if this layer is loaded.
2019-12-07 00:42:55 +00:00
|-------------+--------------------------------------------------------|
| =SPC m h h= | Open helpful buffer for item under point in elisp mode |
| =SPC h d k= | Open helpful buffer for key binding |
| =SPC h d f= | Open helpful buffer for any callable object |
| =SPC h h v= | Open helpful buffer for variable |
[helpful] Bindings and documentation improvements New bindings: `gr` - `helpful-update`, reload helpful buffer. `SPC m q` - `helpful-kill-buffers`, kill all helpful buffers. Move `o` binding definition into separate post-init function, so the binding is defined only if the `link-hint` package is actually installed. Add documentation of the added bindings.
2020-03-23 20:03:08 +00:00
** Helpful mode bindings
documentation formatting: Tue Mar 24 20:40:51 UTC 2020
2020-03-24 20:40:51 +00:00
Additional key bindings available in the helpful-mode buffers.
[helpful] Bindings and documentation improvements New bindings: `gr` - `helpful-update`, reload helpful buffer. `SPC m q` - `helpful-kill-buffers`, kill all helpful buffers. Move `o` binding definition into separate post-init function, so the binding is defined only if the `link-hint` package is actually installed. Add documentation of the added bindings.
2020-03-23 20:03:08 +00:00
| Key binding | Description |
|-------------+----------------------------------------------------|
| =SPC m q= | Close all helpful-mode buffers |
| =gr= | Reload the buffer (e.g. to see new variable value) |
| =o= | Open link with Avy |
| =q= | Close window (buffer is kept in background) |
Reference in a new issue Copy permalink