spacemacs/layers/+tools/imenu-list/README.org
2018-10-11 00:13:43 +03:00

45 lines
1.6 KiB
Org Mode
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#+TITLE: imenu-list layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#screenshot][Screenshot]]
- [[#install][Install]]
- [[#key-bindings][Key bindings]]
- [[#from-any-buffer][From any buffer]]
- [[#from-imenu-list-buffer][From imenu-list buffer]]
* Description
This layer uses [[https://github.com/bmag/imenu-list][imenu-list]] to show the current buffers index in a side bar.
This is similar to `SPC j i` but displayed in a persistent sidebar instead of
a completion buffer.
** Features:
- IDE like outline view of current buffer showing all significant symbols in one view
* Screenshot
[[file:img/imenu-list-example.png]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =imenu-list= to the existing =dotspacemacs-configuration-layers= list in
this file.
* Key bindings
** From any buffer
| Key Binding | Description |
|-------------+--------------------------|
| ~SPC b i~ | toggle imenu-list window |
** From imenu-list buffer
| Key Binding | Description |
|-------------+--------------------------------------------------------|
| ~q~ | quit imenu-list window |
| ~RET~ | go to current entry |
| ~d~ | display current entry, keep focus on imenu-list window |
| ~f~ | fold/unfold current section |
| ~r~ | refresh imenu-list window |