diff --git a/docs-preview-1119/highlightjs/LICENSE b/docs-preview-1018/highlightjs/LICENSE similarity index 100% rename from docs-preview-1119/highlightjs/LICENSE rename to docs-preview-1018/highlightjs/LICENSE diff --git a/docs-preview-1119/highlightjs/highlight.pack.js b/docs-preview-1018/highlightjs/highlight.pack.js similarity index 100% rename from docs-preview-1119/highlightjs/highlight.pack.js rename to docs-preview-1018/highlightjs/highlight.pack.js diff --git a/docs-preview-1119/highlightjs/loader.js b/docs-preview-1018/highlightjs/loader.js similarity index 100% rename from docs-preview-1119/highlightjs/loader.js rename to docs-preview-1018/highlightjs/loader.js diff --git a/docs-preview-1119/highlightjs/mono-blue.css b/docs-preview-1018/highlightjs/mono-blue.css similarity index 100% rename from docs-preview-1119/highlightjs/mono-blue.css rename to docs-preview-1018/highlightjs/mono-blue.css diff --git a/docs-preview-1124/index.xhtml b/docs-preview-1018/index.xhtml similarity index 100% rename from docs-preview-1124/index.xhtml rename to docs-preview-1018/index.xhtml diff --git a/docs-preview-1124/options.html b/docs-preview-1018/options.html similarity index 99% rename from docs-preview-1124/options.html rename to docs-preview-1018/options.html index 38a16da2..3c064773 100644 --- a/docs-preview-1124/options.html +++ b/docs-preview-1018/options.html @@ -45650,11 +45650,12 @@ anything

-

The backend to use for rendering images.

+

The backend to use for rendering images.

Type: -one of “kitty”, “ueberzug”

+one of “kitty”, “ueberzug”, “sixel”

Default: "ueberzug"

diff --git a/docs-preview-1119/quirks.html b/docs-preview-1018/quirks.html similarity index 100% rename from docs-preview-1119/quirks.html rename to docs-preview-1018/quirks.html diff --git a/docs-preview-1119/release-notes.html b/docs-preview-1018/release-notes.html similarity index 100% rename from docs-preview-1119/release-notes.html rename to docs-preview-1018/release-notes.html diff --git a/docs-preview-1119/script/anchor-min.js b/docs-preview-1018/script/anchor-min.js similarity index 100% rename from docs-preview-1119/script/anchor-min.js rename to docs-preview-1018/script/anchor-min.js diff --git a/docs-preview-1119/script/anchor-use.js b/docs-preview-1018/script/anchor-use.js similarity index 100% rename from docs-preview-1119/script/anchor-use.js rename to docs-preview-1018/script/anchor-use.js diff --git a/docs-preview-1119/script/search.js b/docs-preview-1018/script/search.js similarity index 100% rename from docs-preview-1119/script/search.js rename to docs-preview-1018/script/search.js diff --git a/docs-preview-1119/style.css b/docs-preview-1018/style.css similarity index 100% rename from docs-preview-1119/style.css rename to docs-preview-1018/style.css diff --git a/docs-preview-1124/highlightjs/LICENSE b/docs-preview-1095/highlightjs/LICENSE similarity index 100% rename from docs-preview-1124/highlightjs/LICENSE rename to docs-preview-1095/highlightjs/LICENSE diff --git a/docs-preview-1124/highlightjs/highlight.pack.js b/docs-preview-1095/highlightjs/highlight.pack.js similarity index 100% rename from docs-preview-1124/highlightjs/highlight.pack.js rename to docs-preview-1095/highlightjs/highlight.pack.js diff --git a/docs-preview-1124/highlightjs/loader.js b/docs-preview-1095/highlightjs/loader.js similarity index 100% rename from docs-preview-1124/highlightjs/loader.js rename to docs-preview-1095/highlightjs/loader.js diff --git a/docs-preview-1124/highlightjs/mono-blue.css b/docs-preview-1095/highlightjs/mono-blue.css similarity index 100% rename from docs-preview-1124/highlightjs/mono-blue.css rename to docs-preview-1095/highlightjs/mono-blue.css diff --git a/docs-preview-1119/index.xhtml b/docs-preview-1095/index.xhtml similarity index 92% rename from docs-preview-1119/index.xhtml rename to docs-preview-1095/index.xhtml index c126d32f..e87395e1 100644 --- a/docs-preview-1119/index.xhtml +++ b/docs-preview-1095/index.xhtml @@ -651,11 +651,10 @@ deprecated in newer versions is changed in the plugin’s depend on a new version, requesting a version bump in the issues section is a more reliable option.

Language Support

Table of Contents

LSP Custom Packages/Command

Language specific support means there is a combination of language specific -plugins, treesitter support, nvim-lspconfig language servers, conform-nvim -formatters, and nvim-lint linter integration. This gets you capabilities -ranging from autocompletion to formatting to diagnostics. The following -languages have sections under the vim.languages attribute.

Adding support for more languages, and improving support for existing ones are +plugins, treesitter support, nvim-lspconfig language servers, and null-ls +integration. This gets you capabilities ranging from autocompletion to +formatting to diagnostics. The following languages have sections under the +vim.languages attribute.

Adding support for more languages, and improving support for existing ones are great places where you can contribute with a PR.

LSP Custom Packages/Command

One of the strengths of nvf is convenient aliases to quickly configure LSP servers through the Nix module system. By default the LSP packages for relevant language modules will be pulled into the closure. If this is not desirable, you @@ -788,7 +787,7 @@ Each entry in the list is a submodule with the following options:

Autocommands (vim.autocmds)

Autocommands (autocmd) trigger actions based on events happening within Neovim (e.g., saving a file, entering a buffer). Each entry in the list is a submodule -with the following options:

OptionTypeDefaultDescriptionExample
enablebooltrueEnables or disables this autocommand definition.true
eventnullOr (listOf str)nullRequired. List of Neovim events that trigger this autocommand (e.g., BufWritePre, FileType).[ "BufWritePre" ]
patternnullOr (listOf str)nullList of file patterns (globs) to match against (e.g., *.py, *). If null, matches all files for the given event.[ "*.lua", "*.nix" ]
callbacknullOr luaInlinenullA Lua function to execute when the event triggers. Use lib.nvim.types.luaInline or lib.options.literalExpression "mkLuaInline '''...'''". Cannot be used with command.lib.nvim.types.luaInline "function() print('File saved!') end"
commandnullOr strnullA Vimscript command to execute when the event triggers. Cannot be used with callback."echo 'File saved!'"
groupnullOr strnullThe name of an augroup (defined in vim.augroups) to associate this autocommand with."MyCustomAuGroup"
descnullOr strnullA description for the autocommand (useful for introspection)."Format buffer on save"
onceboolfalseIf true, the autocommand runs only once and then automatically removes itself.false
nestedboolfalseIf true, allows this autocommand to trigger other autocommands.false

Warning

You cannot define both callback (for Lua functions) and command (for +with the following options:

OptionTypeDefaultDescriptionExample
enablebooltrueEnables or disables this autocommand definition.true
eventnullOr (listOf str)nullRequired. List of Neovim events that trigger this autocommand (e.g., BufWritePre, FileType).[ "BufWritePre" ]
patternnullOr (listOf str)nullList of file patterns (globs) to match against (e.g., *.py, *). If null, matches all files for the given event.[ "*.lua", "*.nix" ]
callbacknullOr luaInlinenullA Lua function to execute when the event triggers. Use lib.generators.mkLuaInline. Cannot be used with command.lib.generators.mkLuaInline "function() print('File saved!') end"
commandnullOr strnullA Vimscript command to execute when the event triggers. Cannot be used with callback."echo 'File saved!'"
groupnullOr strnullThe name of an augroup (defined in vim.augroups) to associate this autocommand with."MyCustomAuGroup"
descnullOr strnullA description for the autocommand (useful for introspection)."Format buffer on save"
onceboolfalseIf true, the autocommand runs only once and then automatically removes itself.false
nestedboolfalseIf true, allows this autocommand to trigger other autocommands.false

Warning

You cannot define both callback (for Lua functions) and command (for Vimscript) for the same autocommand. Choose one.

Examples:

{ lib, ... }:
 {
   vim.augroups = [ { name = "UserSetup"; } ];
@@ -800,7 +799,7 @@ Vimscript) for the same autocommand. Choose one.

Default: null

-

Example:

mkLuaInline ''
+
Example:
lib.generators.mkLuaInline ''
   function()
       print("Saving a Lua file...")
   end
@@ -16814,54 +16814,6 @@ package

 
Default:
 pkgs.vimPlugins.nvim-treesitter.builtGrammars.elixir

 
-
Declared by:

-
-
-

-
-<nvf/modules/plugins/languages/elixir.nix>
-
-

-
-
- - vim.languages.elixir.treesitter.eexPackage - - -
-
-

The eex treesitter package to use.

- -

Type: -package

- -

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.eex

- -

Declared by:

- - -
- -<nvf/modules/plugins/languages/elixir.nix> - -
-
-
- - vim.languages.elixir.treesitter.heexPackage - - -
-
-

The heex treesitter package to use.

- -

Type: -package

- -

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.heex

-

Declared by:

@@ -21017,7 +20969,7 @@ package

Python formatter to use

Type: -one of “black”, “black-and-isort”, “isort”, “ruff”, “ruff-check”

+one of “black”, “black-and-isort”, “isort”, “ruff”

Default: "black"

@@ -21824,57 +21776,6 @@ boolean

Example: true

-

Declared by:

- - -
- -<nvf/modules/plugins/languages/rust.nix> - -
- -
- - vim.languages.rust.crates.enable - - -
-
-

Whether to enable crates-nvim, tools for managing dependencies.

- -

Type: -boolean

- -

Default: -false

- -

Example: -true

- -

Declared by:

- - -
- -<nvf/modules/plugins/languages/rust.nix> - -
-
-
- - vim.languages.rust.crates.codeActions - - -
-
-

Enable code actions through null-ls

- -

Type: -boolean

- -

Default: -true

-

Declared by:

@@ -21923,6 +21824,83 @@ package

Default: <derivation lldb-19.1.7>

+

Declared by:

+ + +
+ +<nvf/modules/plugins/languages/rust.nix> + +
+ +
+ + vim.languages.rust.extensions.crates-nvim.enable + + +
+
+

Whether to enable crates.io dependency management [crates-nvim].

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/plugins/languages/rust.nix> + +
+
+
+ + vim.languages.rust.extensions.crates-nvim.setupOpts + + +
+
+

Option table to pass into the setup function of crates-nvim

You can pass in any additional options even if they’re +not listed in the docs

+ +

Type: +anything

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<nvf/modules/plugins/languages/rust.nix> + +
+
+
+ + vim.languages.rust.extensions.crates-nvim.setupOpts.completion.enable + + +
+
+

Whether to add crates.nvim as a source for completion plugins. The following +plugins are supported by crates.nvim:

  • nvim-cmp

  • coq.nvim

However nvf only supports auto-setup for nvim-cmp.

+ +

Type: +boolean

+ +

Default: +"{option}`config.vim.autocomplete.nvim-cmp.enable`"

+

Declared by:

@@ -23525,30 +23503,6 @@ package

-

The typescript treesitter package to use.

- -

Type: -package

- -

Default: -pkgs.vimPlugins.nvim-treesitter.builtGrammars.typescript

- -

Declared by:

- - -
- -<nvf/modules/plugins/languages/ts.nix> - -
-
-
- - vim.languages.ts.treesitter.tsxPackage - - -
-

The tsx treesitter package to use.

Type: @@ -24637,7 +24591,7 @@ attribute set of (submodule)

When false, or if the lua function returns false, this plugin will not be included in the spec

Type: -null or boolean or (luaInline)

+null or boolean or string

Default: null

@@ -25114,81 +25068,6 @@ boolean

-
- - vim.lsp.harper-ls.enable - - -
-
-

Whether to enable Harper grammar checking LSP.

- -

Type: -boolean

- -

Default: -false

- -

Example: -true

- -

Declared by:

- - -
- -<nvf/modules/plugins/lsp/harper-ls/harper-ls.nix> - -
-
-
- - vim.lsp.harper-ls.settings - - -
-
-

Settings to pass to harper-ls

- -

Type: -attribute set of anything

- -

Default: -{ }

- -

Example:

{
-  codeActions = {
-    ForceStable = false;
-  };
-  diagnosticSeverity = "hint";
-  dialect = "American";
-  fileDictPath = "";
-  ignoredLintsPath = { };
-  isolateEnglish = false;
-  linters = {
-    BoringWords = true;
-    PossessiveNoun = true;
-    SentenceCapitalization = false;
-    SpellCheck = false;
-  };
-  markdown = {
-    IgnoreLinkTitle = false;
-  };
-  maxFileLength = 120000;
-  userDictPath = "";
-  workspaceDictPath = "";
-}
-
- -

Declared by:

- - -
- -<nvf/modules/plugins/lsp/harper-ls/harper-ls.nix> - -
-
vim.lsp.inlayHints.enable @@ -26772,7 +26651,7 @@ boolean
-

LSP capabilities to pass to LSP server configuration

+

LSP capabilitiess to pass to lspconfig

Type: null or (luaInline) or attribute set of anything

@@ -26820,7 +26699,7 @@ null or (luaInline) or list of string

-

Filetypes to auto-attach LSP server in

+

Filetypes to auto-attach LSP in

Type: null or (list of string)

@@ -45675,11 +45554,12 @@ anything

-

The backend to use for rendering images.

  • kitty - best in class, works great and is very snappy

  • ueberzug - backed by ueberzugpp, supports any terminal, -but has lower performance

+

The backend to use for rendering images.

  • kitty - best in class, works great and is very snappy. Recommended +by upstream.

  • ueberzug - backed by ueberzugpp, supports any terminal, +but has lower performance

  • sixel - uses the Sixel graphics protocol, widely supported by many terminals

Type: -one of “kitty”, “ueberzug”

+one of “kitty”, “ueberzug”, “sixel”

Default: "ueberzug"

diff --git a/docs-preview-1124/quirks.html b/docs-preview-1095/quirks.html similarity index 100% rename from docs-preview-1124/quirks.html rename to docs-preview-1095/quirks.html diff --git a/docs-preview-1124/release-notes.html b/docs-preview-1095/release-notes.html similarity index 100% rename from docs-preview-1124/release-notes.html rename to docs-preview-1095/release-notes.html diff --git a/docs-preview-1124/script/anchor-min.js b/docs-preview-1095/script/anchor-min.js similarity index 100% rename from docs-preview-1124/script/anchor-min.js rename to docs-preview-1095/script/anchor-min.js diff --git a/docs-preview-1124/script/anchor-use.js b/docs-preview-1095/script/anchor-use.js similarity index 100% rename from docs-preview-1124/script/anchor-use.js rename to docs-preview-1095/script/anchor-use.js diff --git a/docs-preview-1124/script/search.js b/docs-preview-1095/script/search.js similarity index 100% rename from docs-preview-1124/script/search.js rename to docs-preview-1095/script/search.js diff --git a/docs-preview-1124/style.css b/docs-preview-1095/style.css similarity index 100% rename from docs-preview-1124/style.css rename to docs-preview-1095/style.css diff --git a/options.html b/options.html index 38a16da2..3c064773 100644 --- a/options.html +++ b/options.html @@ -45650,11 +45650,12 @@ anything

-

The backend to use for rendering images.

  • kitty - best in class, works great and is very snappy

  • ueberzug - backed by ueberzugpp, supports any terminal, -but has lower performance

+

The backend to use for rendering images.

  • kitty - best in class, works great and is very snappy. Recommended +by upstream.

  • ueberzug - backed by ueberzugpp, supports any terminal, +but has lower performance

  • sixel - uses the Sixel graphics protocol, widely supported by many terminals

Type: -one of “kitty”, “ueberzug”

+one of “kitty”, “ueberzug”, “sixel”

Default: "ueberzug"