Skip to content

Commit c03d8e8

Browse files
committed
Add documentation about renderer/comparator
1 parent 7c7c99a commit c03d8e8

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

doc/fern.txt

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ INTRODUCTION |fern-introduction|
1111
USAGE |fern-usage|
1212
ACTION |fern-action|
1313
CUSTOM |fern-custom|
14+
COMPARATOR |fern-comparator|
15+
RENDERER |fern-renderer|
1416
INTERFACE |fern-interface|
1517
VARIABLE |fern-variable|
1618
COMMAND |fern-command|
@@ -211,6 +213,70 @@ For example, following execute "open" on leaf but "expand" on branch.
211213
<
212214
See https://github.com/lambdalisue/fern.vim/wiki/ for custom tips.
213215

216+
217+
=============================================================================
218+
COMPARATOR *fern-comparator*
219+
220+
Comparator is an object to sort nodes for making a tree.
221+
Users can create user custom comparator to change the order of appearance of
222+
nodes in the tree.
223+
See |fern-develop-comparator| for more details.
224+
225+
226+
=============================================================================
227+
RENDERER *fern-renderer*
228+
229+
Renderer is an object to render nodes as a tree like (default renderer):
230+
>
231+
fern.vim
232+
* |- autoload
233+
|+ fern
234+
|+ vital
235+
* | fern.vim
236+
* |- doc
237+
| fern-develop.txt
238+
| fern.txt
239+
| tags
240+
|+ ftplugin
241+
|+ plugin
242+
|+ test
243+
| LICENSE
244+
| README.md
245+
<
246+
Users can customize above appearance by the following variables.
247+
248+
*g:fern#renderer#default#leading*
249+
A |String| used as leading space unit (one indentation level.)
250+
Default: " "
251+
252+
*g:fern#renderer#default#root_symbol*
253+
A |String| used as a symbol of root node.
254+
Default: ""
255+
256+
*g:fern#renderer#default#leaf_symbol*
257+
A |String| used as a symbol of leaf node (non branch node like file).
258+
Default: "| "
259+
260+
*g:fern#renderer#default#collapsed_symbol*
261+
A |String| used as a symbol of collapsed branch node.
262+
Default: "|+ "
263+
264+
*g:fern#renderer#default#expanded_symbol*
265+
A |String| used as a symbol of expanded branch node.
266+
Default: "|- "
267+
268+
*g:fern#renderer#default#marked_symbol*
269+
A |String| used as a symbol of mark.
270+
Default: "* "
271+
272+
*g:fern#renderer#default#marked_symbol*
273+
A |String| used as a symbol of unmark.
274+
Default: " "
275+
276+
Or create user custom renderer to change the appearance completely.
277+
See |fern-develop-renderer| for more details.
278+
279+
214280
=============================================================================
215281
INTERFACE *fern-interface*
216282

0 commit comments

Comments
 (0)