Skip to content

Commit

Permalink
Merge pull request #119 from Cassin01/features/#113
Browse files Browse the repository at this point in the history
update mini.nvim version
  • Loading branch information
Cassin01 committed Mar 10, 2024
2 parents f77678c + 7b739f6 commit 716f215
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions doc/wf.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,29 @@ tag char action
------------------------------------------------------------------------------
*wf.select*
`select`({items}, {opts}, {on_choice})
Parameters~
Parameters ~
{items} items
{opts} WFOptions
{on_choice} `(fun(string, table)|fun(num,)` table)
Usage~
Usage ~
`require("wf").select(items, opts, on_choice)`


==============================================================================
------------------------------------------------------------------------------
*wf.setup*
`setup`({opts})
Parameters~
Parameters ~
{opts} `(optional)` WFConfig


==============================================================================
------------------------------------------------------------------------------
*wf.builtin.bookmark*
`bookmark`({bookmark_dirs}, {opts})
Usage~
Usage ~
bookmark({nvim="~/.config/nvim", zsh="~/.zshrc"})
Parameters~
Parameters ~
{bookmark_dirs} `(table)`
{opts} `(optional)` WFOptions

Expand All @@ -58,50 +58,50 @@ Parameters~
------------------------------------------------------------------------------
*wf.builtin.buffer*
`buffer`({opts})
Parameters~
Parameters ~
{opts} `(optional)` WFOptions


==============================================================================
------------------------------------------------------------------------------
*wf.builtin.mark*
`mark`({opts})
Parameters~
Parameters ~
{opts} `(optional)` WFOptions


==============================================================================
------------------------------------------------------------------------------
*wf.builtin.register*
`register`({opts})
Parameters~
Parameters ~
{opts} `(optional)` WFOptions


==============================================================================
------------------------------------------------------------------------------
*wf.builtin.which_key*
`which_key`({opts})
Parameters~
Parameters ~
{opts} `(optional)` WFOptions


==============================================================================
------------------------------------------------------------------------------
Class~
Class ~
{hl_group} string Highlight group name, e.g. "ErrorMsg"

------------------------------------------------------------------------------
Class~
Class ~
{WFkeymaps}
Fields~
Fields ~
{escape} `(string)`
{toggle} `(string)`

------------------------------------------------------------------------------
Class~
Class ~
{WFHighlight}
Fields~
Fields ~
{WFNormal} hl_group
{WFFloatBorder} hl_group
{WFFloatBorderFocus} hl_group
Expand All @@ -124,17 +124,17 @@ Fields~
{WFTitleFreeze} hl_group

------------------------------------------------------------------------------
Class~
Class ~
{WFConfig}
Fields~
Fields ~
{theme} `(optional)` "default"|"space"|"chad"
{highlight} `(optional)` WFHighlight
{builtin_keymaps} WFkeymaps

------------------------------------------------------------------------------
Class~
Class ~
{WFBehavior}
Fields~
Fields ~
{skip_front_duplication} `(boolean)`
Example:
When there are two lines:
Expand All @@ -151,23 +151,23 @@ When there are two lines:
At this time, the candidate is uniquely determined, so confirm the candidate before pressiong `j`.

------------------------------------------------------------------------------
Class~
Class ~
{Cell}
Fields~
Fields ~
{key} `(string)`
{id} `(string)`
{text} `(string)`
{type} "key"|"group"

------------------------------------------------------------------------------
Class~
Class ~
{Chunks}
list of [text, hl_group] arrays, each representing a text chunk with specified highlight. hl_group element can not be omitted for not

------------------------------------------------------------------------------
Class~
Class ~
{WFStyle}
Fields~
Fields ~
{border} `(string)`
of window border. This can either be a string or an array.
nvim_open_win
Expand All @@ -179,14 +179,14 @@ nvim_open_win
number a width for windows

------------------------------------------------------------------------------
Class~
Class ~
{WFOptions}
Fields~
Fields ~
{title} `(string?)`
{selector} "which"|"fuzzy"
{text_insert_in_advance} `(string)`
{key_group_dict} `(table)`
Usage~
Usage ~
key_group_dict = { "<leader>l"="vimtex", "<leader>e"="conjure" }
{prefix_size} `(number)`
{sorter} `(function)`
Expand Down

0 comments on commit 716f215

Please sign in to comment.