Skip to content

Commit

Permalink
Add documentation about renderer/comparator
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Jul 30, 2020
1 parent 7c7c99a commit c03d8e8
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions doc/fern.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ INTRODUCTION |fern-introduction|
USAGE |fern-usage|
ACTION |fern-action|
CUSTOM |fern-custom|
COMPARATOR |fern-comparator|
RENDERER |fern-renderer|
INTERFACE |fern-interface|
VARIABLE |fern-variable|
COMMAND |fern-command|
Expand Down Expand Up @@ -211,6 +213,70 @@ For example, following execute "open" on leaf but "expand" on branch.
<
See https://github.com/lambdalisue/fern.vim/wiki/ for custom tips.


=============================================================================
COMPARATOR *fern-comparator*

Comparator is an object to sort nodes for making a tree.
Users can create user custom comparator to change the order of appearance of
nodes in the tree.
See |fern-develop-comparator| for more details.


=============================================================================
RENDERER *fern-renderer*

Renderer is an object to render nodes as a tree like (default renderer):
>
fern.vim
* |- autoload
|+ fern
|+ vital
* | fern.vim
* |- doc
| fern-develop.txt
| fern.txt
| tags
|+ ftplugin
|+ plugin
|+ test
| LICENSE
| README.md
<
Users can customize above appearance by the following variables.

*g:fern#renderer#default#leading*
A |String| used as leading space unit (one indentation level.)
Default: " "

*g:fern#renderer#default#root_symbol*
A |String| used as a symbol of root node.
Default: ""

*g:fern#renderer#default#leaf_symbol*
A |String| used as a symbol of leaf node (non branch node like file).
Default: "| "

*g:fern#renderer#default#collapsed_symbol*
A |String| used as a symbol of collapsed branch node.
Default: "|+ "

*g:fern#renderer#default#expanded_symbol*
A |String| used as a symbol of expanded branch node.
Default: "|- "

*g:fern#renderer#default#marked_symbol*
A |String| used as a symbol of mark.
Default: "* "

*g:fern#renderer#default#marked_symbol*

This comment has been minimized.

Copy link
@rafi

rafi Jul 30, 2020

@lambdalisue duplicate help tag

This comment has been minimized.

Copy link
@lambdalisue

lambdalisue Jul 30, 2020

Author Owner

Thanks!

A |String| used as a symbol of unmark.
Default: " "

Or create user custom renderer to change the appearance completely.
See |fern-develop-renderer| for more details.


=============================================================================
INTERFACE *fern-interface*

Expand Down

0 comments on commit c03d8e8

Please sign in to comment.