From a865a6f88ad4393325541f8743dc56e05888daa2 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 13 May 2025 11:23:41 +0000 Subject: [PATCH] Deploy PR #865 preview --- docs-preview-865/options.html | 265 +++++++++++++++++++++++++++++++--- 1 file changed, 241 insertions(+), 24 deletions(-) diff --git a/docs-preview-865/options.html b/docs-preview-865/options.html index 2db8cdc8..af6c481c 100644 --- a/docs-preview-865/options.html +++ b/docs-preview-865/options.html @@ -3984,6 +3984,247 @@ package (read only)

+
+ + vim.clipboard.enable + + +
+
+

Whether to enable clipboard management for Neovim. Users may still choose to manage their +clipboard through vim.options should they wish to avoid using +this module. +.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers + + +
+
+

Clipboard providers for which packages will be added to nvf’s +extraPackages. The package field may be set to null +if related packages are already found in system packages to +potentially reduce closure sizes.

+ +

Type: +submodule

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.wl-copy.enable + + +
+
+

Whether to enable wl-copy.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.wl-copy.package + + +
+
+

The wl-clipboard package to use.

+ +

Type: +null or package

+ +

Default: +pkgs.wl-clipboard

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.xclip.enable + + +
+
+

Whether to enable xclip.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.xclip.package + + +
+
+

The xclip package to use.

+ +

Type: +null or package

+ +

Default: +pkgs.xclip

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.xsel.enable + + +
+
+

Whether to enable xsel.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.providers.xsel.package + + +
+
+

The xsel package to use.

+ +

Type: +null or package

+ +

Default: +pkgs.xsel

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
+
+ + vim.clipboard.registers + + +
+
+

The register to be used by the Neovim clipboard. Recognized types are:

  • unnamed: Vim will use the clipboard register "*" for all yank, delete, +change and put operations which would normally go to the unnamed register.

  • unnamedplus: A variant of the “unnamed” flag which uses the clipboard register +"+" (:h quoteplus) instead of register "*" for all yank, delete, +change and put operations which would normally go to the unnamed register.

When unnamed and unnamedplus is included simultaneously yank and delete +operations (but not put) will additionally copy the text into register "*".

Please see :h clipboard for more details.

+ +

Type: +string or list of string

+ +

Default: +""

+ +

Example: +"unnamedplus"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/clipboard.nix> + +
+
vim.comments.comment-nvim.enable @@ -42815,30 +43056,6 @@ string or (luaInline)

Example:

mkLuaInline "os.getenv('XDG_DATA_HOME') .. '/nvf/undo'"
-

Declared by:

- - -
- -<nvf/modules/neovim/init/basic.nix> - -
- -
- - vim.useSystemClipboard - - -
-
-

Make use of the clipboard for default yank and paste operations. Don’t use * and +

- -

Type: -boolean

- -

Default: -false

-

Declared by: