Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document the nil case for dirvish-default-layout. #231

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document the nil case for dirvish-default-layout. #231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions dirvish.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,22 @@ Credit: copied from `consult-preview-variables' in `consult.el'."

(defcustom dirvish-default-layout '(1 0.11 0.55)
"Default layout recipe for fullscreen Dirvish sessions.
The value has the form (DEPTH MAX-PARENT-WIDTH PREVIEW-WIDTH).
The value has the form (DEPTH MAX-PARENT-WIDTH PREVIEW-WIDTH),
if not nil. Neither the parent windows or the preview windows are
shown if the value is nil.

DEPTH controls the number of windows displaying parent
directories. It can be 0 if you don't need the parent
directories. MAX-PARENT-WIDTH controls the max width allocated
to each parent windows. PREVIEW-WIDTH controls the width
allocated to preview window. The default value provides a
1:3:5 (approximately) pane ratio. Also see
`dirvish-layout-recipes' in `dirvish-extras.el'."
:group 'dirvish :type '(list (integer :tag "number of parent windows")
(float :tag "max width of parent windows")
(float :tag "width of preview windows")))
:group 'dirvish
:type '(choice (const :tag "no default layout" nil)
(list (integer :tag "number of parent windows")
(float :tag "max width of parent windows")
(float :tag "width of preview windows"))))

(defface dirvish-hl-line
'((t :inherit highlight :extend t))
Expand Down