imenu-list: update README.org

This commit is contained in:
syl20bnr 2016-04-08 18:14:39 -04:00
parent 6f2e2df275
commit 3f0a261206
1 changed files with 25 additions and 17 deletions

View File

@ -1,29 +1,37 @@
* imenu-list contribution layer for Spacemacs
** 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]]
#+TITLE: imenu-list layer
** 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 is similar to `SPC j i` but displayed in a persistent sidebar instead of
a completion buffer.
* Screenshot
[[file:img/imenu-list-example.png]]
** Install
To use this contribution add it to your =~/.spacemacs=
* 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.
#+begin_src emacs-lisp
(setq-default dotspacemacs-configuration-layers '(imenu-list))
#+end_src
* Key bindings
** From any buffer
** Key bindings
*** From any buffer
| Key Binding | Description |
|-------------+--------------------------|
| ~SPC b i~ | toggle imenu-list window |
*** From imenu-list buffer
** From imenu-list buffer
| Key Binding | Description |
|-------------+--------------------------------------------------------|
| ~q~ | quit imenu-list window |