chore: generated vimdoc from README

main
bhagwan 2 years ago
parent b52f92a46b
commit 10e8be0e63

@ -11,8 +11,8 @@ Customization <#customization> • Wiki
Demo <https://raw.githubusercontent.com/wiki/ibhagwan/fzf-lua/demo.gif> Demo <https://raw.githubusercontent.com/wiki/ibhagwan/fzf-lua/demo.gif>
fzf <https://github.com/junegunn/fzf> changed my life, it can change yours fzf <https://github.com/junegunn/fzf> changed my command life, it can change
too, if you allow it. yours too, if you allow it.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -38,9 +38,8 @@ shiny fuzzy finders for neovim.
WHY FZF-LUA *fzf-lua-why-fzf-lua* WHY FZF-LUA *fzf-lua-why-fzf-lua*
... and not, to name a few, telescope ... and not telescope <https://github.com/nvim-telescope/telescope.nvim> or
<https://github.com/nvim-telescope/telescope.nvim> or vim-clap any other vim/neovim household name?
<https://github.com/liuchengxu/vim-clap>?
As @junegunn <https://github.com/junegunn> himself put it, “because you can As @junegunn <https://github.com/junegunn> himself put it, “because you can
and you love `fzf`”. and you love `fzf`”.
@ -291,10 +290,15 @@ NVIM-DAP *fzf-lua-nvim-dap*
CUSTOMIZATION *fzf-lua-customization* CUSTOMIZATION *fzf-lua-customization*
I tried to make it as customizable as possible, if you find you need to change **ADVANCED CUSTOMIZATION <https://github.com/ibhagwan/fzf-lua/wiki/Advanced> :
something that isnt below, open an issue and Ill do my best to add it. to create your own fzf-lua commands see Wiki/ADVANCED
<https://github.com/ibhagwan/fzf-lua/wiki/Advanced>**
customization can be achieved by calling the `setup()` function or I tried to make this plugin as customizable as possible, if you find you need
to change something that isnt below, open an issue and Ill do my best to
add it.
Customization can be achieved by calling the `setup()` function or
individually sending parameters to a builtin command, for example: individually sending parameters to a builtin command, for example:
> >
@ -336,7 +340,7 @@ Consult the list below for available settings:
cursor = 'Cursor', -- cursor highlight (grep/LSP matches) cursor = 'Cursor', -- cursor highlight (grep/LSP matches)
cursorline = 'CursorLine', -- cursor line cursorline = 'CursorLine', -- cursor line
cursorlinenr = 'CursorLineNr', -- cursor line number cursorlinenr = 'CursorLineNr', -- cursor line number
search = 'IncSearch', -- search matches (ctags) search = 'IncSearch', -- search matches (ctags|help)
-- title = 'Normal', -- preview border title (file/buffer) -- title = 'Normal', -- preview border title (file/buffer)
-- scrollbar_f = 'PmenuThumb', -- scrollbar "full" section highlight -- scrollbar_f = 'PmenuThumb', -- scrollbar "full" section highlight
-- scrollbar_e = 'PmenuSbar', -- scrollbar "empty" section highlight -- scrollbar_e = 'PmenuSbar', -- scrollbar "empty" section highlight
@ -856,7 +860,7 @@ and plugin codes that I probably forgot where I found some samples from so if
I missed your name feel free to contact me and I'll add it below: I missed your name feel free to contact me and I'll add it below:
- @vijaymarupudi <https://github.com/vijaymarupudi/> for his wonderful - @vijaymarupudi <https://github.com/vijaymarupudi/> for his wonderful
nvim-fzf <https://github.com/vijaymarupudi/nvim-fzf> plugin which is in the nvim-fzf <https://github.com/vijaymarupudi/nvim-fzf> plugin which is at the
core of this plugin core of this plugin
- @tjdevries <https://github.com/tjdevries/> for too many great things to list - @tjdevries <https://github.com/tjdevries/> for too many great things to list
here and for borrowing some of his nvim-telescope here and for borrowing some of his nvim-telescope
@ -874,4 +878,4 @@ I missed your name feel free to contact me and I'll add it below:
as baseline for the builtin previewer and his must have plugin nvim-bqf as baseline for the builtin previewer and his must have plugin nvim-bqf
<https://github.com/kevinhwang91/nvim-bqf> <https://github.com/kevinhwang91/nvim-bqf>
vim:tw=78:ts=8:ft=help:norl: vim:tw=78:ts=8:ft=help:norl:
Loading…
Cancel
Save