This commit is contained in:
NotAShelf 2026-03-24 10:14:41 +00:00
commit 874f169ee0
15 changed files with 311 additions and 57279 deletions

View file

@ -12242,6 +12242,132 @@
</details>
</li>
<li>
<details class="toc-category">
<summary title="vim.opts">
<span>vim.opts</span>
<span class="toc-count">14</span>
</summary>
<ul>
<li>
<a href='#option-vim-opts' class="parent-option" title="vim.opts">
vim.opts
</a>
</li>
<li>
<a href='#option-vim-opts-autoindent' title="vim.opts.autoindent">
autoindent
</a>
</li>
<li>
<a href='#option-vim-opts-cmdheight' title="vim.opts.cmdheight">
cmdheight
</a>
</li>
<li>
<a href='#option-vim-opts-cursorlineopt' title="vim.opts.cursorlineopt">
cursorlineopt
</a>
</li>
<li>
<a href='#option-vim-opts-mouse' title="vim.opts.mouse">
mouse
</a>
</li>
<li>
<a href='#option-vim-opts-shiftwidth' title="vim.opts.shiftwidth">
shiftwidth
</a>
</li>
<li>
<a href='#option-vim-opts-signcolumn' title="vim.opts.signcolumn">
signcolumn
</a>
</li>
<li>
<a href='#option-vim-opts-splitbelow' title="vim.opts.splitbelow">
splitbelow
</a>
</li>
<li>
<a href='#option-vim-opts-splitright' title="vim.opts.splitright">
splitright
</a>
</li>
<li>
<a href='#option-vim-opts-tabstop' title="vim.opts.tabstop">
tabstop
</a>
</li>
<li>
<a href='#option-vim-opts-termguicolors' title="vim.opts.termguicolors">
termguicolors
</a>
</li>
<li>
<a href='#option-vim-opts-tm' title="vim.opts.tm">
tm
</a>
</li>
<li>
<a href='#option-vim-opts-updatetime' title="vim.opts.updatetime">
updatetime
</a>
</li>
<li>
<a href='#option-vim-opts-wrap' title="vim.opts.wrap">
wrap
</a>
</li>
</ul>
</details>
</li>
<li>
<details class="toc-category">
<summary title="vim.presence">
@ -37825,6 +37951,190 @@ the <code class="command">:retab</code> command, and the <code class="nixos-opti
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts">
<h3 class="option-name">
<a href="#option-vim-opts" class="option-anchor">vim.opts</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>open submodule of attribute set of anything</code></div>
<div class="option-description"><html><head></head><body><p>Alias of <a class="option-reference" href="options.html#option-vim-options"><code class="nixos-option">vim.options</code></a>.</p>
</body></html></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/neovim/init/basic.nix" target="_blank">&lt;nvf/modules/neovim/init/basic.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-autoindent">
<h3 class="option-name">
<a href="#option-vim-opts-autoindent" class="option-anchor">vim.opts.autoindent</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>boolean</code></div>
<div class="option-description"><html><head></head><body><p>Enable auto indent</p>
</body></html></div>
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-cmdheight">
<h3 class="option-name">
<a href="#option-vim-opts-cmdheight" class="option-anchor">vim.opts.cmdheight</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>signed integer</code></div>
<div class="option-description"><html><head></head><body><p>Height of the command pane</p>
</body></html></div>
<div class="option-default">Default: <code>1</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-cursorlineopt">
<h3 class="option-name">
<a href="#option-vim-opts-cursorlineopt" class="option-anchor">vim.opts.cursorlineopt</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>one of "line", "screenline", "number", "both"</code></div>
<div class="option-description"><html><head></head><body><p>Highlight the text line of the cursor with CursorLine hl-CursorLine</p>
</body></html></div>
<div class="option-default">Default: <code>"line"</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-mouse">
<h3 class="option-name">
<a href="#option-vim-opts-mouse" class="option-anchor">vim.opts.mouse</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>string</code></div>
<div class="option-description"><html><head></head><body><p>Set modes for mouse support.</p>
<ul>
<li>n - normal</li>
<li>v - visual</li>
<li>i - insert</li>
<li>c - command-line</li>
<li>h - all modes when editing a help file</li>
<li>a - all modes</li>
<li>r - for hit-enter and more-prompt prompt</li>
</ul>
<p>This option takes a string to ensure proper conversion to the corresponding Lua type.
As such, we do not check the value passed to this option. Please ensure that any value
that is set here is a valid value as per <a href="https://neovim.io/doc/user/options.html#'mouse'%22">neovim documentation</a>.</p>
</body></html></div>
<div class="option-default">Default: <code>"nvi"</code></div>
<div class="option-example">Example: <code>"a"</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-shiftwidth">
<h3 class="option-name">
<a href="#option-vim-opts-shiftwidth" class="option-anchor">vim.opts.shiftwidth</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>signed integer</code></div>
<div class="option-description"><html><head></head><body><p>Number of spaces to use for each step of (auto)indent. Used for
<code class="nixos-option">cindent</code>, <code>&gt;&gt;</code>, <code>&lt;&lt;</code>, etc.</p>
<p>When zero the <code class="nixos-option">tabstop</code> value will be used.</p>
</body></html></div>
<div class="option-default">Default: <code>8</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-signcolumn">
<h3 class="option-name">
<a href="#option-vim-opts-signcolumn" class="option-anchor">vim.opts.signcolumn</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>string</code></div>
<div class="option-description"><html><head></head><body><p>Whether to show the sign column</p>
</body></html></div>
<div class="option-default">Default: <code>"yes"</code></div>
<div class="option-example">Example: <code>"no"</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-splitbelow">
<h3 class="option-name">
<a href="#option-vim-opts-splitbelow" class="option-anchor">vim.opts.splitbelow</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>boolean</code></div>
<div class="option-description"><html><head></head><body><p>New splits will open below instead of on top</p>
</body></html></div>
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-splitright">
<h3 class="option-name">
<a href="#option-vim-opts-splitright" class="option-anchor">vim.opts.splitright</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>boolean</code></div>
<div class="option-description"><html><head></head><body><p>New splits will open to the right</p>
</body></html></div>
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-tabstop">
<h3 class="option-name">
<a href="#option-vim-opts-tabstop" class="option-anchor">vim.opts.tabstop</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>signed integer</code></div>
<div class="option-description"><html><head></head><body><p>Number of spaces that a <code>&lt;Tab&gt;</code> in the file counts for. Also see
the <code class="command">:retab</code> command, and the <code class="nixos-option">softtabstop</code> option.</p>
</body></html></div>
<div class="option-default">Default: <code>8</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-termguicolors">
<h3 class="option-name">
<a href="#option-vim-opts-termguicolors" class="option-anchor">vim.opts.termguicolors</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>boolean</code></div>
<div class="option-description"><html><head></head><body><p>Set terminal up for 256 colours</p>
</body></html></div>
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-tm">
<h3 class="option-name">
<a href="#option-vim-opts-tm" class="option-anchor">vim.opts.tm</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>signed integer</code></div>
<div class="option-description"><html><head></head><body><p>Timeout in ms that Neovim will wait for mapped action to complete</p>
</body></html></div>
<div class="option-default">Default: <code>500</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-updatetime">
<h3 class="option-name">
<a href="#option-vim-opts-updatetime" class="option-anchor">vim.opts.updatetime</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>signed integer</code></div>
<div class="option-description"><html><head></head><body><p>The number of milliseconds till Cursor Hold event is fired</p>
</body></html></div>
<div class="option-default">Default: <code>300</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-opts-wrap">
<h3 class="option-name">
<a href="#option-vim-opts-wrap" class="option-anchor">vim.opts.wrap</a>
<span class="copy-link" title="Copy link to this option"></span>
<span class="copy-feedback">Link copied!</span>
</h3>
<div class="option-type">Type: <code>boolean</code></div>
<div class="option-description"><html><head></head><body><p>Enable word wrapping.</p>
</body></html></div>
<div class="option-default">Default: <code>true</code></div>
<div class="option-declared">Declared in: <code><a href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_blank">&lt;nvf/modules/wrapper/rc/options.nix&gt;</a></code></div>
</div>
<div class="option" id="option-vim-package">
<h3 class="option-name">
<a href="#option-vim-package" class="option-anchor">vim.package</a>