lauchmelder/vim-sussify
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Doc: explain all keys for the Funcref type

Browse source
This commit is contained in:
Marco Hinz 2018-07-03 21:09:33 +02:00
parent 675f8fcc14
commit 7bbc46e1c2
No known key found for this signature in database
GPG key ID: 1C980A1B657B4A4F
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/startify.txt
View file

@ -186,10 +186,16 @@ Built-in types:~
Funcref type:~ Funcref type:~
The referenced function must return a list of dictionaries. Each dictionary The referenced function must return a list of dictionaries. Each dictionary
is an entry and consists of two keys: 'line' and 'cmd'. is an entry that consists of these keys:
'line' is the actual entry to display and 'cmd' is a Vim command to execute 'line' The text to display for this entry. (required)
when this entry gets chosen.
'cmd' The Vim command to execute when the entry gets chosen.
(required unless 'path' is given)
'path' Points to a file. This way you can even use the standard markers
like `s` or `v` etc. to open multiple entries at once.
(required unless 'cmd' is given)
Example #1:~ Example #1:~
> >