docs: add note for bootstrap (#261)

* docs: remove unnecessary `main` from code example

* docs: add note for `bootstrap`
This commit is contained in:
JINNOUCHI Yasushi 2024-09-05 23:36:35 +09:00 committed by GitHub
parent 1b63e9453d
commit dbca328c59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -332,7 +332,6 @@ register opened files as soon as Neovim has started. Example configuration for
>lua >lua
{ {
"nvim-telescope/telescope-frecency.nvim", "nvim-telescope/telescope-frecency.nvim",
main = "frecency",
-- `opts` property calls the plugin's setup() function. -- `opts` property calls the plugin's setup() function.
-- In this case, this calls frecency.setup(). -- In this case, this calls frecency.setup().
opts = { opts = {
@ -418,6 +417,16 @@ Type: `boolean`
If `true`, it removes stale entries count over than If `true`, it removes stale entries count over than
|telescope-frecency-configuration-db_validate_threshold|. |telescope-frecency-configuration-db_validate_threshold|.
*telescope-frecency-configuration-bootstrap*
bootstrap ~
Default: `true`
Type: `boolean`
If `true` and you set this plugin to be loaded non-lazily, it initializes DB in
Neovim startup (before |VimEnter|). This initialization logic works
asynchronously and does not block Neovim's starting process.
*telescope-frecency-configuration-db_root* *telescope-frecency-configuration-db_root*
db_root ~ db_root ~