1
1
#+AUTHOR: Alex Lu
2
2
3
3
#+startup: content
4
+ #+html: <img src="https://user-images.githubusercontent.com/16313743/159204052-c8caf89d-c44f-42c7-a177-4cd2491eaab6.svg" align="center" width="100%">
5
+ -----
6
+ #+html: <p align="center"><i>A minimalistic yet versatile file manager based on</i> <b>Dired</b></p>
4
7
5
- * *Dirvish*
6
-
7
- [[https://melpa.org/#/dirvish][file:https://melpa.org/packages/dirvish-badge.svg]]
8
- [[https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml][file:https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml/badge.svg]]
9
-
10
- #+begin_quote
11
- A minimalistic yet versatile file manager based on *Dired*.
12
- #+end_quote
13
-
14
- ** Introduction
8
+ * Introduction
15
9
16
10
This package gives Dired the following features:
17
11
18
- - Multiple window layouts
19
- - Always available file preview
20
- - Isolated sessions
21
- - Asynchronous directory listing
22
- - A modern and composable user interface
12
+ + Multiple window layouts
13
+ + Always available file preview
14
+ + Isolated sessions
15
+ + Asynchronous directory listing
16
+ + A modern and composable user interface
23
17
24
18
A Dired, a [[https://github.com/ranger/ranger][ranger]], a [[https://github.com/jaypei/emacs-neotree][neotree]], this is Dirvish ;)
25
19
26
- ** Screenshots
20
+ * Screenshots
27
21
28
- [[https://raw .githubusercontent.com/alexluigit/binaries/main/dirvish/assets/main .png][https://raw .githubusercontent.com/alexluigit/binaries/main/dirvish/assets/main .png]]
22
+ [[https://user-images .githubusercontent.com/16313743/159170480-1901925c-e4dc-4c43-a280-348890bdfcf4 .png][https://user-images .githubusercontent.com/16313743/159170480-1901925c-e4dc-4c43-a280-348890bdfcf4 .png]]
29
23
*Figure 1*. ~dirvish~: A file browser/manager with live preview
30
24
31
25
https://user-images.githubusercontent.com/16313743/156968548-cb091eb5-179d-48bd-aa3d-04add862440a.mp4
@@ -40,18 +34,18 @@ https://user-images.githubusercontent.com/16313743/158773638-e6252372-8eff-4035-
40
34
41
35
*Figure 4*. Huge directories no longer hung up Emacs
42
36
43
- ** Installation
37
+ * Installation
44
38
45
39
Dirvish is available on [[https://melpa.org][Melpa]], you can install it directly via ~package-install~
46
40
if you have melpa in your ~package-archives~.
47
41
48
- *** For =straight.el= users
42
+ ** For =straight.el= users
49
43
50
44
#+begin_src emacs-lisp
51
45
(straight-use-package 'dirvish)
52
46
#+end_src
53
47
54
- *** Manual install
48
+ ** Manual install
55
49
56
50
To install it manually, first clone this repository, then add =path/to/dirvish= to your ~load-path~.
57
51
@@ -62,7 +56,7 @@ To install it manually, first clone this repository, then add =path/to/dirvish=
62
56
(require 'dirvish)
63
57
#+end_src
64
58
65
- ** Quickstart
59
+ * Quickstart
66
60
67
61
Start a Dirvish session by =M-x= ~dirvish~ or ~dirvish-dired~.
68
62
@@ -80,7 +74,7 @@ It is also recommended to enable ~dirvish-override-dired-mode~, which makes all
80
74
your Dired entry commands including ~dired[-other-window/tab/frame]~ initialize or
81
75
reuse a Dirvish session automatically.
82
76
83
- ** Extensions
77
+ * Extensions
84
78
85
79
Several small extension packages to Dirvish are maintained in the subdirectory
86
80
extensions/. They are installed together with Dirvish if you pull the package
@@ -99,11 +93,11 @@ Currently the following extensions come with the package:
99
93
With these extensions it is possible to adapt Dirvish such that it matches your
100
94
preference or behaves similar to other familiar file explorers.
101
95
102
- ** Customization
96
+ * Customization
103
97
104
98
See [[file:Configuration.org][Configuration.org]] (included docs for extensions).
105
99
106
- ** Related projects
100
+ * Related projects
107
101
108
102
Generally speaking, Dirvish should be able to handle most of the file
109
103
exploring/managing tasks, after all it is backed by the superb Dired. Besides,
@@ -112,40 +106,40 @@ choose Dirvish over packages listed below gives you:
112
106
2. File preview at your disposal.
113
107
3. Less package configs to maintain or worry about.
114
108
115
- *** neotree
109
+ ** neotree
116
110
117
111
=neotree= works pretty well as a simple project explorer. But sadly, compare to
118
112
=dirvish[-side]=, this package is not built on top of Dired, which means you have
119
113
to learn or configure a different set of commands, meanwhile, it is way less
120
114
powerful as Dired/Dirvish in terms of file managing.
121
115
122
- *** treemacs
116
+ ** treemacs
123
117
124
118
Same as =neotree=, but =treemacs= is a much more mature yet complex package. It can
125
119
even be used as a general rendering backend of any tree-like structures, you may
126
120
find this package useful when you have related needs. It might be an overkill
127
121
for simple project exploring tasks due to its complexity and huge codebase.
128
122
129
- *** dired-sidebar
123
+ ** dired-sidebar
130
124
131
125
=dired-sidebar= and =dirvish-side= do almost exact the same thing: create a file
132
126
explorer at side window that leveraging the power of Dired. =dired-sidebar= also
133
127
includes some basic integration with serveral 3rd-party packages and other small
134
128
niceties such as file watching. =dirvish-side=, at least for now, is relatively
135
129
primitive.
136
130
137
- *** ranger.el
131
+ ** ranger.el
138
132
139
133
See this [[https://github.com/alexluigit/dirvish/issues/10][discussion]].
140
134
141
- ** Issues
135
+ * Issues
142
136
143
137
- There maybe incompatibilities with other third-party Dired packages.
144
138
145
139
Please feel free to report any issues.
146
140
147
- ** FAQ
148
- *** How is Dirvish related to Dired?
141
+ * FAQ
142
+ ** How is Dirvish related to Dired?
149
143
150
144
A Dirvish session holds a set of buffers with ~dirvish-mode~ as its ~major-mode~. As
151
145
discussed above, since ~dirvish-mode~ is a derived mode from ~dired-mode~, most of
@@ -178,13 +172,17 @@ Nonetheless, Dirvish and Dired handle these aspects differently:
178
172
~dirvish-mode-line-format~, hence the ~dired-switches-in-mode-line~ option doesn't
179
173
work in Dirvish.
180
174
181
- *** How do I customize the preview content?
175
+ ** How do I customize the preview content?
182
176
183
177
See [[https://github.com/alexluigit/dirvish/blob/main/Configuration.org#preview-strategies][Preview strategies]].
184
178
185
- ** Acknowledgements
179
+ * Acknowledgements
186
180
187
181
This package is inspired a lot by [[https://github.com/ralesi/ranger.el][ranger.el]], thanks @ralesi for creating and
188
182
maintaining it.
189
183
190
184
The name *dirvish* is a tribute to [[https://github.com/justinmk/vim-dirvish][vim-dirvish]].
185
+ -----
186
+ [[https://melpa.org/#/dirvish][file:https://melpa.org/packages/dirvish-badge.svg]]
187
+ [[https://stable.melpa.org/#/dirvish][file:https://stable.melpa.org/packages/dirvish-badge.svg]]
188
+ [[https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml][file:https://github.com/alexluigit/dirvish/actions/workflows/melpazoid.yml/badge.svg]]
0 commit comments