Table of Contents
Table of Contents
If you noticed a bug caused by nvf then please consider reporting it over the issue tracker.
Bugfixes, feature additions and upstreamed changes from your local configurations are always welcome in the the pull requests tab.
@@ -826,12 +826,12 @@ function is part of nixpkgs.Example:
- Next
+ Next
- Appendix A. Neovim Flake Configuration Options
+ Appendix A. Plugin specific quirks
diff --git a/options.html b/options.html
index 67dd285..7ce0be4 100644
--- a/options.html
+++ b/options.html
@@ -4,27 +4,27 @@
- Appendix A. Neovim Flake Configuration Options
+ Appendix B. Neovim Flake Configuration Options
-
+
Appendix A. Neovim Flake Configuration Options
Below are the options provided by nvf provided in no particular order.
+
Appendix B. Neovim Flake Configuration Options
Below are the options provided by nvf provided in no particular order.
They may include useful comments and warnings, or examples on how a module option
is meant to be used.
@@ -19927,6 +19927,13 @@ list of string
},
}
''
+ ''
+ {
+ "",
+ draw_empty = true,
+ separator = { left = '', right = '' }
+ }
+ ''
]
@@ -19967,6 +19974,13 @@ list of string
separator = {right = ''}
}
''
+ ''
+ {
+ "",
+ draw_empty = true,
+ separator = { left = '', right = '' }
+ }
+ ''
]
@@ -20109,6 +20123,13 @@ list of string
list of string
Default:
[
+ ''
+ {
+ "",
+ draw_empty = true,
+ separator = { left = '', right = '' }
+ }
+ ''
''
{
'searchcount',
@@ -20149,6 +20170,13 @@ list of string
list of string
Default:
[
+ ''
+ {
+ "",
+ draw_empty = true,
+ separator = { left = '', right = '' }
+ }
+ ''
''
{
"progress",
@@ -25432,7 +25460,7 @@ boolean
-Option table to pass into the setup function of nvim-colorizer
You can pass in any additional options even if they’re
+
Option table to pass into the setup function of colorizer
You can pass in any additional options even if they’re
not listed in the docs
Type:
@@ -25457,14 +25485,20 @@ attribute set of anything
-Filetypes to highlight on
+Filetypes to enable on and their option overrides.
“*” means enable on all filetypes. Filetypes prefixed with “!” are disabled.
Type:
-attribute set of (attribute set)
+attribute set of (submodule)
-Default:
{
- css = { };
- scss = { };
+Default:
+{ }
+
+Example:
{
+ "!vim" = { };
+ "*" = { };
+ javascript = {
+ AARRGGBB = false;
+ };
}
@@ -25479,18 +25513,474 @@ attribute set of (attribute set)
- vim.ui.colorizer.setupOpts.user_default_options.alwaysUpdate
+ vim.ui.colorizer.setupOpts.filetypes.<name>.AARRGGBB
-Update color values even if buffer is not focused, like when using cmp_menu, cmp_docs
+Colorize 0xAARRGGBB hex codes
Type:
-boolean
+null or boolean
Default:
-false
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.RGB
+
+
+
+
+Colorize #RGB hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.RRGGBB
+
+
+
+
+Colorize #RRGGBB hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.RRGGBBAA
+
+
+
+
+Colorize #RRGGBBAA hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.always_update
+
+
+
+
+Update color values even if buffer is not focused. Example use: cmp_menu, cmp_docs
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.css
+
+
+
+
+Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.css_fn
+
+
+
+
+Enable all CSS functions: rgb_fn, hsl_fn
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.hsl_fn
+
+
+
+
+Colorize CSS hsl() and hsla() functions
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.mode
+
+
+
+
+Set the display mode
+
+Type:
+null or one of “foreground”, “background”
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.names
+
+
+
+
+Colorize “Name” codes like Blue
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.rgb_fn
+
+
+
+
+Colorize CSS rgb() and rgba() functions
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.sass
+
+
+
+
+Enable sass colors
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.tailwind
+
+
+
+
+Enable tailwind colors
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.filetypes.<name>.virtualtext
+
+
+
+
+String to display as virtualtext
+
+Type:
+null or string
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options
+
+
+
+
+Default options
+
+Type:
+submodule
+
+Default:
+{ }
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.AARRGGBB
+
+
+
+
+Colorize 0xAARRGGBB hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.RGB
+
+
+
+
+Colorize #RGB hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.RRGGBB
+
+
+
+
+Colorize #RRGGBB hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.RRGGBBAA
+
+
+
+
+Colorize #RRGGBBAA hex codes
+
+Type:
+null or boolean
+
+Default:
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.always_update
+
+
+
+
+Update color values even if buffer is not focused. Example use: cmp_menu, cmp_docs
+
+Type:
+null or boolean
+
+Default:
+null
Declared by:
@@ -25511,10 +26001,10 @@ boolean
Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB
Type:
-boolean
+null or boolean
Default:
-false
+null
Declared by:
@@ -25535,10 +26025,10 @@ boolean
Enable all CSS functions: rgb_fn, hsl_fn
Type:
-boolean
+null or boolean
Default:
-false
+null
Declared by:
@@ -25556,13 +26046,13 @@ boolean
-CSS hsl() and hsla() functions
+Colorize CSS hsl() and hsla() functions
Type:
-boolean
+null or boolean
Default:
-false
+null
Declared by:
@@ -25583,10 +26073,10 @@ boolean
Set the display mode
Type:
-one of “foreground”, “background”
+null or one of “foreground”, “background”
Default:
-"background"
+null
Declared by:
@@ -25604,37 +26094,13 @@ one of “foreground”, “background”
-“Name” codes such as “Blue”
+Colorize “Name” codes like Blue
Type:
-boolean
+null or boolean
Default:
-true
-
-Declared by:
-
-
-
-<nvf/modules/plugins/ui/colorizer/colorizer.nix>
-
-
-
-
-
- vim.ui.colorizer.setupOpts.user_default_options.rgb
-
-
-
-
-#RGB hex codes
-
-Type:
-boolean
-
-Default:
-true
+null
Declared by:
@@ -25652,61 +26118,13 @@ boolean
-CSS rgb() and rgba() functions
+Colorize CSS rgb() and rgba() functions
Type:
-boolean
+null or boolean
Default:
-false
-
-Declared by:
-
-
-
-<nvf/modules/plugins/ui/colorizer/colorizer.nix>
-
-
-
-
-
- vim.ui.colorizer.setupOpts.user_default_options.rrggbb
-
-
-
-
-#RRGGBB hex codes
-
-Type:
-boolean
-
-Default:
-true
-
-Declared by:
-
-
-
-<nvf/modules/plugins/ui/colorizer/colorizer.nix>
-
-
-
-
-
- vim.ui.colorizer.setupOpts.user_default_options.rrggbbaa
-
-
-
-
-#RRGGBBAA hex codes
-
-Type:
-boolean
-
-Default:
-false
+null
Declared by:
@@ -25727,10 +26145,10 @@ boolean
Enable sass colors
Type:
-boolean
+null or boolean
Default:
-false
+null
Declared by:
@@ -25751,10 +26169,34 @@ boolean
Enable tailwind colors
Type:
-boolean
+null or boolean
Default:
-false
+null
+
+Declared by:
+
+
+
+<nvf/modules/plugins/ui/colorizer/colorizer.nix>
+
+
+
+
+
+ vim.ui.colorizer.setupOpts.user_default_options.virtualtext
+
+
+
+
+String to display as virtualtext
+
+Type:
+null or string
+
+Default:
+null
Declared by:
@@ -30336,14 +30778,14 @@ boolean
- Prev
+ Prev
Next
- nvf manual
+ Appendix A. Plugin specific quirks
Home
- Appendix B. Release Notes
+ Appendix C. Release Notes
diff --git a/plugins.html b/plugins.html
new file mode 100644
index 0000000..d241b76
--- /dev/null
+++ b/plugins.html
@@ -0,0 +1,46 @@
+
+
+
+
+
+ Appendix A. Plugin specific quirks
+
+
+
+
+
+
+
+ Appendix A. Plugin specific quirks
At times, certain plugins refuse to play nicely. Be it as a result of generating
+lua from Nix, or the state of packaging. This page shall list any plugins that
+are known to misbehave, and potential workarounds.
+
+
+
\ No newline at end of file
diff --git a/release-notes.html b/release-notes.html
index 7e92997..6154859 100644
--- a/release-notes.html
+++ b/release-notes.html
@@ -4,18 +4,18 @@
- Appendix B. Release Notes
+ Appendix C. Release Notes
-
+
Appendix B. Release Notes
Table of Contents
This section lists the release notes for tagged version of nvf and
+
Appendix C. Release Notes
Table of Contents
This section lists the release notes for tagged version of nvf and
the current main current main branch
Release 0.1
Table of Contents
This is the current master branch and information here is not final. These are changes from the v0.01 tag.
Special thanks to home-manager for this release.
Docs/manual generation, the new module evaluation system, and DAG implementation are from them.
Changelog
Removed hare language support (lsp/tree-sitter/etc). vim.lsp.hare is no longer defined.
If you use hare and would like it added back, please file an issue.
vim.stratPlugins & vim.optPlugins are now
@@ -165,7 +165,7 @@ blending issues in component separators.
- Appendix A. Neovim Flake Configuration Options
+ Appendix B. Neovim Flake Configuration Options
Home