imenu-list: update README.org
This commit is contained in:
parent
6f2e2df275
commit
3f0a261206
|
@ -1,29 +1,37 @@
|
||||||
* imenu-list contribution layer for Spacemacs
|
#+TITLE: imenu-list layer
|
||||||
** Table of Contents :TOC@4:
|
|
||||||
- [[#imenu-list-contribution-layer-for-spacemacs][imenu-list contribution layer for Spacemacs]]
|
|
||||||
- [[#description][Description]]
|
|
||||||
- [[#install][Install]]
|
|
||||||
- [[#key-bindings][Key bindings]]
|
|
||||||
- [[#from-any-buffer][From any buffer]]
|
|
||||||
- [[#from-imenu-list-buffer][From imenu-list buffer]]
|
|
||||||
|
|
||||||
** Description
|
* Table of Contents :TOC_4_gh:noexport:
|
||||||
|
- [[#description][Description]]
|
||||||
|
- [[#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 buffer's index in a side bar.
|
This layer uses [[https://github.com/bmag/imenu-list][imenu-list]] to show the current buffer's index in a side bar.
|
||||||
|
|
||||||
|
This is similar to `SPC j i` but displayed in a persistent sidebar instead of
|
||||||
|
a completion buffer.
|
||||||
|
|
||||||
|
* Screenshot
|
||||||
|
|
||||||
[[file:img/imenu-list-example.png]]
|
[[file:img/imenu-list-example.png]]
|
||||||
|
|
||||||
** Install
|
* Install
|
||||||
To use this contribution add it to your =~/.spacemacs=
|
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.
|
||||||
|
|
||||||
#+begin_src emacs-lisp
|
* Key bindings
|
||||||
(setq-default dotspacemacs-configuration-layers '(imenu-list))
|
** From any buffer
|
||||||
#+end_src
|
|
||||||
|
|
||||||
** Key bindings
|
|
||||||
*** From any buffer
|
|
||||||
| Key Binding | Description |
|
| Key Binding | Description |
|
||||||
|-------------+--------------------------|
|
|-------------+--------------------------|
|
||||||
| ~SPC b i~ | toggle imenu-list window |
|
| ~SPC b i~ | toggle imenu-list window |
|
||||||
*** From imenu-list buffer
|
|
||||||
|
** From imenu-list buffer
|
||||||
|
|
||||||
| Key Binding | Description |
|
| Key Binding | Description |
|
||||||
|-------------+--------------------------------------------------------|
|
|-------------+--------------------------------------------------------|
|
||||||
| ~q~ | quit imenu-list window |
|
| ~q~ | quit imenu-list window |
|
||||||
|
|
Loading…
Reference in New Issue