Improve vinegar layer documentation
This commit is contained in:
parent
1e31d3b46f
commit
06534391a6
|
@ -1,29 +1,19 @@
|
||||||
#+TITLE: Vinegar layer
|
#+TITLE: Vinegar layer
|
||||||
|
|
||||||
* Table of Contents :TOC_4_gh:noexport:
|
* Table of Contents :TOC_4_gh:noexport:
|
||||||
- [[#configuration][Configuration]]
|
|
||||||
- [[#description][Description]]
|
- [[#description][Description]]
|
||||||
- [[#features][Features:]]
|
- [[#features][Features:]]
|
||||||
- [[#mouse-bindings][Mouse bindings]]
|
- [[#install][Install]]
|
||||||
- [[#key-bindings][Key bindings]]
|
- [[#layer][Layer]]
|
||||||
|
- [[#reuse-dired-buffer][Reuse dired buffer]]
|
||||||
* Configuration
|
- [[#deactive-hide-details-mode][Deactive hide details mode]]
|
||||||
|
- [[#mouse-bindings][Mouse bindings]]
|
||||||
The default configuration of this layer is:
|
- [[#key-bindings][Key bindings]]
|
||||||
|
|
||||||
#+BEGIN_SRC emacs-lisp
|
|
||||||
(setq-default dotspacemacs-configuration-layers '(
|
|
||||||
(vinegar :variables
|
|
||||||
vinegar-reuse-dired-buffer nil
|
|
||||||
vinegar-dired-hide-details t)
|
|
||||||
))
|
|
||||||
#+END_SRC
|
|
||||||
|
|
||||||
* Description
|
* Description
|
||||||
This layer is a port layer for vim-vinegar for emacs.
|
This layer is a port of vim-vinegar for emacs.
|
||||||
|
|
||||||
A port of tpope’s
|
It is based on tpope’s [[https://github.com/tpope/vim-vinegar][vinegar.vim]], simplifying =dired=
|
||||||
[[https://github.com/tpope/vim-vinegar][vinegar.vim]], simplifying =dired=
|
|
||||||
with a limited number of details and exposing the ~-~ command in all
|
with a limited number of details and exposing the ~-~ command in all
|
||||||
buffers to enter dired.
|
buffers to enter dired.
|
||||||
|
|
||||||
|
@ -36,6 +26,30 @@ buffers to enter dired.
|
||||||
single bar
|
single bar
|
||||||
- right mouse click moves up directory if in blank space or shows context menu
|
- right mouse click moves up directory if in blank space or shows context menu
|
||||||
|
|
||||||
|
* Install
|
||||||
|
** Layer
|
||||||
|
To use this configuration layer add =vinegar= to the
|
||||||
|
=dotspacemacs-configuration-layers= list.
|
||||||
|
|
||||||
|
** Reuse dired buffer
|
||||||
|
To reuse dired buffers set the variable =vinegar-reuse-dired-buffer= to =t=.
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(setq-default dotspacemacs-configuration-layers '(
|
||||||
|
(vinegar :variables
|
||||||
|
vinegar-reuse-dired-buffer nil))
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
|
** Deactive hide details mode
|
||||||
|
Per default extensive details in dired are hidden with this layer.
|
||||||
|
This can be deactivated by setting the variable =vinegar-dired-hide-details= to =nil=.
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(setq-default dotspacemacs-configuration-layers '(
|
||||||
|
(vinegar :variables
|
||||||
|
vinegar-dired-hide-details t)))
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
** Mouse bindings
|
** Mouse bindings
|
||||||
|
|
||||||
| Mouse Binding | Description |
|
| Mouse Binding | Description |
|
||||||
|
|
Loading…
Reference in a new issue