From 06534391a6e724afd06191aa7a06da904064fbfb Mon Sep 17 00:00:00 2001 From: smile13241324 Date: Sat, 20 Apr 2019 23:39:13 +0200 Subject: [PATCH] Improve vinegar layer documentation --- layers/+vim/vinegar/README.org | 50 ++++++++++++++++++++++------------ 1 file changed, 32 insertions(+), 18 deletions(-) diff --git a/layers/+vim/vinegar/README.org b/layers/+vim/vinegar/README.org index b27a33e88..53d22639a 100644 --- a/layers/+vim/vinegar/README.org +++ b/layers/+vim/vinegar/README.org @@ -1,29 +1,19 @@ #+TITLE: Vinegar layer * Table of Contents :TOC_4_gh:noexport: -- [[#configuration][Configuration]] - [[#description][Description]] - [[#features][Features:]] - - [[#mouse-bindings][Mouse bindings]] - - [[#key-bindings][Key bindings]] - -* Configuration - -The default configuration of this layer is: - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '( - (vinegar :variables - vinegar-reuse-dired-buffer nil - vinegar-dired-hide-details t) - )) -#+END_SRC +- [[#install][Install]] + - [[#layer][Layer]] + - [[#reuse-dired-buffer][Reuse dired buffer]] + - [[#deactive-hide-details-mode][Deactive hide details mode]] +- [[#mouse-bindings][Mouse bindings]] +- [[#key-bindings][Key bindings]] * 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 -[[https://github.com/tpope/vim-vinegar][vinegar.vim]], simplifying =dired= +It is based on tpope’s [[https://github.com/tpope/vim-vinegar][vinegar.vim]], simplifying =dired= with a limited number of details and exposing the ~-~ command in all buffers to enter dired. @@ -36,6 +26,30 @@ buffers to enter dired. single bar - 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 Binding | Description |