From 54203bb6f98fee5424721a1fcaad62ed52e9c6b1 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Thu, 23 Jan 2025 15:36:33 +0000 Subject: [PATCH] Deploy PR #571 preview --- docs-preview-571/options.html | 580 ++++++++++++++++++++++++++++++++++ 1 file changed, 580 insertions(+) diff --git a/docs-preview-571/options.html b/docs-preview-571/options.html index 250f5f25..80119a50 100644 --- a/docs-preview-571/options.html +++ b/docs-preview-571/options.html @@ -8310,6 +8310,586 @@ boolean

+
+ + vim.highlight + + +
+
+

Custom highlights to apply

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Example:

{
+  SignColumn = {
+    bg = "#282828";
+  };
+}
+
+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.bg + + +
+
+

The background color to use. Written as color name or hex “#RRGGBB”.

+ +

Type: +null or RGB color in hex format

+ +

Default: +null

+ +

Example: +"#ebdbb2"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.blend + + +
+
+

Blend as an integer between 0 and 100

+ +

Type: +null or integer between 0 and 100 (both inclusive)

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.bold + + +
+
+

Whether to enable bold

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.cterm + + +
+
+

The cterm arguments to use. See ‘:h highlight-args’

+ +

Type: +null or (list of (one of “bold”, “underline”, “undercurl”, “underdouble”, “underdotted”, “underdashed”, “strikethrough”, “reverse”, “inverse”, “italic”, “standout”, “altfont”, “nocombine”, “NONE”))

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.ctermbg + + +
+
+

The cterm background color to use

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.ctermfg + + +
+
+

The cterm foreground color to use

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.default + + +
+
+

Don’t override existing definition

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.fg + + +
+
+

The foreground color to use. Written as color name or hex “#RRGGBB”.

+ +

Type: +null or RGB color in hex format

+ +

Default: +null

+ +

Example: +"#ebdbb2"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.force + + +
+
+

Whether to enable force update

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.italic + + +
+
+

Whether to enable italic

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.link + + +
+
+

The name of another highlight group to link to

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.nocombine + + +
+
+

Whether to enable nocombine

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.reverse + + +
+
+

Whether to enable reverse

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.sp + + +
+
+

The special color to use. Written as color name or hex “#RRGGBB”.

+ +

Type: +null or RGB color in hex format

+ +

Default: +null

+ +

Example: +"#ebdbb2"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.standout + + +
+
+

Whether to enable standout

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.strikethrough + + +
+
+

Whether to enable strikethrough

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.undercurl + + +
+
+

Whether to enable undercurl

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.underdashed + + +
+
+

Whether to enable underdashed

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.underdotted + + +
+
+

Whether to enable underdotted

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.underdouble + + +
+
+

Whether to enable underdouble

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
+
+ + vim.highlight.<name>.underline + + +
+
+

Whether to enable underline

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Example: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/highlight.nix> + +
+
vim.keymaps