2016-04-08 22:14:39 +00:00
|
|
|
#+TITLE: imenu-list layer
|
|
|
|
|
2019-05-02 21:49:30 +00:00
|
|
|
#+TAGS: layer|tool
|
|
|
|
|
2019-05-07 20:05:06 +00:00
|
|
|
* Table of Contents :TOC_5_gh:noexport:
|
2017-05-22 14:16:12 +00:00
|
|
|
- [[#description][Description]]
|
2017-12-07 17:23:06 +00:00
|
|
|
- [[#features][Features:]]
|
2017-05-22 14:16:12 +00:00
|
|
|
- [[#screenshot][Screenshot]]
|
|
|
|
- [[#install][Install]]
|
|
|
|
- [[#key-bindings][Key bindings]]
|
|
|
|
- [[#from-any-buffer][From any buffer]]
|
|
|
|
- [[#from-imenu-list-buffer][From imenu-list buffer]]
|
2016-04-08 22:14:39 +00:00
|
|
|
|
|
|
|
* Description
|
2019-05-26 20:58:52 +00:00
|
|
|
This layer uses [[https://github.com/bmag/imenu-list][imenu-list]] to show the current buffer's index in a side bar.
|
2016-04-08 22:14:39 +00:00
|
|
|
|
|
|
|
This is similar to `SPC j i` but displayed in a persistent sidebar instead of
|
|
|
|
a completion buffer.
|
|
|
|
|
2017-12-07 17:23:06 +00:00
|
|
|
** Features:
|
|
|
|
- IDE like outline view of current buffer showing all significant symbols in one view
|
|
|
|
|
2016-04-08 22:14:39 +00:00
|
|
|
* Screenshot
|
2015-09-22 19:11:33 +00:00
|
|
|
[[file:img/imenu-list-example.png]]
|
|
|
|
|
2016-04-08 22:14:39 +00:00
|
|
|
* 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.
|
2015-09-22 19:11:33 +00:00
|
|
|
|
2016-04-08 22:14:39 +00:00
|
|
|
* Key bindings
|
|
|
|
** From any buffer
|
2015-09-22 19:11:33 +00:00
|
|
|
|
2018-12-05 03:03:03 +00:00
|
|
|
| Key binding | Description |
|
2015-09-22 19:11:33 +00:00
|
|
|
|-------------+--------------------------|
|
2019-06-26 03:58:14 +00:00
|
|
|
| ~SPC b t~ | toggle imenu tree window |
|
2016-04-08 22:14:39 +00:00
|
|
|
|
|
|
|
** From imenu-list buffer
|
|
|
|
|
2018-12-05 03:03:03 +00:00
|
|
|
| Key binding | Description |
|
2015-09-22 19:11:33 +00:00
|
|
|
|-------------+--------------------------------------------------------|
|
|
|
|
| ~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 |
|
2017-11-04 03:04:53 +00:00
|
|
|
| ~r~ | refresh imenu-list window |
|