Skip to content

Commit 4e2db43

Browse files
committed
docs(readme): add logo
1 parent 7d85d06 commit 4e2db43

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

README.org

+31-33
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,25 @@
11
#+AUTHOR: Alex Lu
22
33
#+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>
47

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
159

1610
This package gives Dired the following features:
1711

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
2317

2418
A Dired, a [[https://github.com/ranger/ranger][ranger]], a [[https://github.com/jaypei/emacs-neotree][neotree]], this is Dirvish ;)
2519

26-
** Screenshots
20+
* Screenshots
2721

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]]
2923
*Figure 1*. ~dirvish~: A file browser/manager with live preview
3024

3125
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-
4034

4135
*Figure 4*. Huge directories no longer hung up Emacs
4236

43-
** Installation
37+
* Installation
4438

4539
Dirvish is available on [[https://melpa.org][Melpa]], you can install it directly via ~package-install~
4640
if you have melpa in your ~package-archives~.
4741

48-
*** For =straight.el= users
42+
** For =straight.el= users
4943

5044
#+begin_src emacs-lisp
5145
(straight-use-package 'dirvish)
5246
#+end_src
5347

54-
*** Manual install
48+
** Manual install
5549

5650
To install it manually, first clone this repository, then add =path/to/dirvish= to your ~load-path~.
5751

@@ -62,7 +56,7 @@ To install it manually, first clone this repository, then add =path/to/dirvish=
6256
(require 'dirvish)
6357
#+end_src
6458

65-
** Quickstart
59+
* Quickstart
6660

6761
Start a Dirvish session by =M-x= ~dirvish~ or ~dirvish-dired~.
6862

@@ -80,7 +74,7 @@ It is also recommended to enable ~dirvish-override-dired-mode~, which makes all
8074
your Dired entry commands including ~dired[-other-window/tab/frame]~ initialize or
8175
reuse a Dirvish session automatically.
8276

83-
** Extensions
77+
* Extensions
8478

8579
Several small extension packages to Dirvish are maintained in the subdirectory
8680
extensions/. They are installed together with Dirvish if you pull the package
@@ -99,11 +93,11 @@ Currently the following extensions come with the package:
9993
With these extensions it is possible to adapt Dirvish such that it matches your
10094
preference or behaves similar to other familiar file explorers.
10195

102-
** Customization
96+
* Customization
10397

10498
See [[file:Configuration.org][Configuration.org]] (included docs for extensions).
10599

106-
** Related projects
100+
* Related projects
107101

108102
Generally speaking, Dirvish should be able to handle most of the file
109103
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:
112106
2. File preview at your disposal.
113107
3. Less package configs to maintain or worry about.
114108

115-
*** neotree
109+
** neotree
116110

117111
=neotree= works pretty well as a simple project explorer. But sadly, compare to
118112
=dirvish[-side]=, this package is not built on top of Dired, which means you have
119113
to learn or configure a different set of commands, meanwhile, it is way less
120114
powerful as Dired/Dirvish in terms of file managing.
121115

122-
*** treemacs
116+
** treemacs
123117

124118
Same as =neotree=, but =treemacs= is a much more mature yet complex package. It can
125119
even be used as a general rendering backend of any tree-like structures, you may
126120
find this package useful when you have related needs. It might be an overkill
127121
for simple project exploring tasks due to its complexity and huge codebase.
128122

129-
*** dired-sidebar
123+
** dired-sidebar
130124

131125
=dired-sidebar= and =dirvish-side= do almost exact the same thing: create a file
132126
explorer at side window that leveraging the power of Dired. =dired-sidebar= also
133127
includes some basic integration with serveral 3rd-party packages and other small
134128
niceties such as file watching. =dirvish-side=, at least for now, is relatively
135129
primitive.
136130

137-
*** ranger.el
131+
** ranger.el
138132

139133
See this [[https://github.com/alexluigit/dirvish/issues/10][discussion]].
140134

141-
** Issues
135+
* Issues
142136

143137
- There maybe incompatibilities with other third-party Dired packages.
144138

145139
Please feel free to report any issues.
146140

147-
** FAQ
148-
*** How is Dirvish related to Dired?
141+
* FAQ
142+
** How is Dirvish related to Dired?
149143

150144
A Dirvish session holds a set of buffers with ~dirvish-mode~ as its ~major-mode~. As
151145
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:
178172
~dirvish-mode-line-format~, hence the ~dired-switches-in-mode-line~ option doesn't
179173
work in Dirvish.
180174

181-
*** How do I customize the preview content?
175+
** How do I customize the preview content?
182176

183177
See [[https://github.com/alexluigit/dirvish/blob/main/Configuration.org#preview-strategies][Preview strategies]].
184178

185-
** Acknowledgements
179+
* Acknowledgements
186180

187181
This package is inspired a lot by [[https://github.com/ralesi/ranger.el][ranger.el]], thanks @ralesi for creating and
188182
maintaining it.
189183

190184
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]]

extensions/dirvish-extras.el

+4-2
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,16 @@
2121
;; - `dirvish-roam'
2222
;;
2323
;; Attributes
24-
;; - `file-size' attribute at right fringe
25-
;; - `vs-icon' attribute
24+
;; - `file-size' attribute
25+
;; - `expanded-state' attribute
26+
;; - `vscode-icon' attribute
2627
;; - `all-the-icons' attribute
2728

2829
;;; Code:
2930

3031
(declare-function all-the-icons-icon-for-file "all-the-icons")
3132
(declare-function all-the-icons-icon-for-dir "all-the-icons")
33+
(declare-function all-the-icons-octicon "all-the-icons")
3234
(declare-function vscode-icon-can-scale-image-p "vscode-icon")
3335
(declare-function vscode-icon-file "vscode-icon")
3436
(declare-function vscode-icon-dir-exists-p "vscode-icon")

0 commit comments

Comments
 (0)