options.html

@@ -72,6 +72,30 @@ lazy attribute set of raw value</p>
 </td></tr>
 </table>
 </dd>
+<dt>
+ <span class="term">
+ <a id="opt-vim.enableEditorconfig"></a><a class="term" href="options.html#opt-vim.enableEditorconfig"><code class="option">vim.enableEditorconfig</code>
+  </a>
+ </span>
+</dt>
+<dd>
+<p>Follow editorconfig rules in current directory</p>
+
+<p><span class="emphasis"><em>Type:</em></span>
+boolean</p>
+
+<p><span class="emphasis"><em>Default:</em></span>
+<code class="literal">true</code></p>
+
+<p><span class="emphasis"><em>Declared by:</em></span></p>
+<table border="0" summary="Simple list" class="simplelist">
+<tr><td>
+<code class="filename"><a class="filename"  href="https://github.com/NotAShelf/nvf/blob/main/modules/neovim/init/basic.nix" target="_top">
+&lt;nvf/modules/neovim/init/basic.nix&gt;
+</a></code>
+</td></tr>
+</table>
+</dd>
 <dt>
  <span class="term">
  <a id="opt-vim.enableLuaLoader"></a><a class="term" href="options.html#opt-vim.enableLuaLoader"><code class="option">vim.enableLuaLoader</code>
@@ -80,7 +104,7 @@ lazy attribute set of raw value</p>
 </dt>
 <dd>
 <p>the experimental Lua module loader to speed up the start up process</p><p>If <code class="literal">true</code>, this will enable the experimental Lua module loader which:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>overrides loadfile</p></li><li class="listitem"><p>adds the lua loader using the byte-compilation cache</p></li><li class="listitem"><p>adds the libs loader</p></li><li class="listitem"><p>removes the default Neovim loader</p></li></ul></div><div class="note"><h3 class="title">Note</h3><p>The Lua module loader is <span class="emphasis"><em>disabled</em></span> by default. Before setting this option, please
-take a look at the <code class="option">[official documentation]</code>. This option may be enabled by
+take a look at the <a class="link" href="https://neovim.io/doc/user/lua.html#vim.loader.enable()"  target="_top"><code class="option">official documentation</code></a>. This option may be enabled by
 default in the future.</p></div>
 
 <p><span class="emphasis"><em>Type:</em></span>
@@ -3319,7 +3343,7 @@ list of (path or string)</p>
   ./nvim/my-lua-file.lua
 
   # source type path - pure and reproducible
-  (builtins.path {
+  (builtins.source {
     path = ./nvim/my-lua-file.lua;
     name = &quot;my-lua-file&quot;;
   })
@@ -8102,33 +8126,6 @@ attribute set of anything</p>
 }
 </code></pre>
 
-<p><span class="emphasis"><em>Declared by:</em></span></p>
-<table border="0" summary="Simple list" class="simplelist">
-<tr><td>
-<code class="filename"><a class="filename"  href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_top">
-&lt;nvf/modules/wrapper/rc/options.nix&gt;
-</a></code>
-</td></tr>
-</table>
-</dd>
-<dt>
- <span class="term">
- <a id="opt-vim.globals.editorconfig"></a><a class="term" href="options.html#opt-vim.globals.editorconfig"><code class="option">vim.globals.editorconfig</code>
-  </a>
- </span>
-</dt>
-<dd>
-<p>Whether to enable EditorConfig integration in Neovim.</p><p>This defaults to true as it is enabled by default in stock
-Neovim, setting this option to false disables EditorConfig
-integration entirely.</p><p>See <a class="link" href="https://neovim.io/doc/user/editorconfig.html"  target="_top">Neovim documentation</a>
-for more details on configuring EditorConfig behaviour.</p>
-
-<p><span class="emphasis"><em>Type:</em></span>
-boolean</p>
-
-<p><span class="emphasis"><em>Default:</em></span>
-<code class="literal">true</code></p>
-
 <p><span class="emphasis"><em>Declared by:</em></span></p>
 <table border="0" summary="Simple list" class="simplelist">
 <tr><td>
@@ -12956,7 +12953,7 @@ package or list of string</p>
 <p>Nix LSP server to use</p>
 
 <p><span class="emphasis"><em>Type:</em></span>
-value “nil” (singular enum)</p>
+one of “nil”, “rnix”</p>
 
 <p><span class="emphasis"><em>Default:</em></span>
 <code class="literal">&quot;nil&quot;</code></p>
@@ -19237,7 +19234,7 @@ to the <code class="literal">runtimepath</code> and enable the experimental Lua
 if <a class="xref" href="options.html#opt-vim.enableLuaLoader"  ><code class="option">vim.enableLuaLoader</code></a> is set to true.</p>
 
 <p><span class="emphasis"><em>Example:</em></span>
-<code class="literal">${builtins.readFile ./my-lua-config-pre.lua}</code></p>
+<code class="literal">&quot;$${builtins.readFile ./my-lua-config-pre.lua}&quot;</code></p>
 
 <p><span class="emphasis"><em>Declared by:</em></span></p>
 <table border="0" summary="Simple list" class="simplelist">
@@ -22403,6 +22400,30 @@ null or string</p>
 <p><span class="emphasis"><em>Default:</em></span>
 <code class="literal">null</code></p>
 
+<p><span class="emphasis"><em>Declared by:</em></span></p>
+<table border="0" summary="Simple list" class="simplelist">
+<tr><td>
+<code class="filename"><a class="filename"  href="https://github.com/NotAShelf/nvf/blob/main/modules/plugins/notes/obsidian/obsidian.nix" target="_top">
+&lt;nvf/modules/plugins/notes/obsidian/obsidian.nix&gt;
+</a></code>
+</td></tr>
+</table>
+</dd>
+<dt>
+ <span class="term">
+ <a id="opt-vim.notes.obsidian.setupOpts.dir"></a><a class="term" href="options.html#opt-vim.notes.obsidian.setupOpts.dir"><code class="option">vim.notes.obsidian.setupOpts.dir</code>
+  </a>
+ </span>
+</dt>
+<dd>
+<p>Obsidian vault directory</p>
+
+<p><span class="emphasis"><em>Type:</em></span>
+string</p>
+
+<p><span class="emphasis"><em>Default:</em></span>
+<code class="literal">&quot;~/my-vault&quot;</code></p>
+
 <p><span class="emphasis"><em>Declared by:</em></span></p>
 <table border="0" summary="Simple list" class="simplelist">
 <tr><td>
@@ -23138,17 +23159,12 @@ one of “line”, “screenline”, “number”, “both”</p>
  </span>
 </dt>
 <dd>
-<p>Set modes for mouse support.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>n - normal</p></li><li class="listitem"><p>v - visual</p></li><li class="listitem"><p>i - insert</p></li><li class="listitem"><p>c - command-line</p></li><li class="listitem"><p>h - all modes when editing a help file</p></li><li class="listitem"><p>a - all modes</p></li><li class="listitem"><p>r - for hit-enter and more-prompt prompt</p></li></ul></div><p>This option takes a string to ensure proper conversion to the corresponding Lua type.
+<p>Set modes for mouse support.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>a - all</p></li><li class="listitem"><p>n - normal</p></li><li class="listitem"><p>v - visual</p></li><li class="listitem"><p>i - insert</p></li><li class="listitem"><p>c - command</p></li></ul></div>
-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 class="link" href="https://neovim.io/doc/user/options.html#&#x27;mouse&#x27;%22"  target="_top">neovim documentation</a>.</p>
 
 <p><span class="emphasis"><em>Type:</em></span>
-string</p>
+one of “a”, “n”, “v”, “i”, “c”</p>
 
 <p><span class="emphasis"><em>Default:</em></span>
-<code class="literal">&quot;nvi&quot;</code></p>
-
-<p><span class="emphasis"><em>Example:</em></span>
 <code class="literal">&quot;a&quot;</code></p>
 
 <p><span class="emphasis"><em>Declared by:</em></span></p>
@@ -23176,30 +23192,6 @@ signed integer</p>
 <p><span class="emphasis"><em>Default:</em></span>
 <code class="literal">8</code></p>
 
-<p><span class="emphasis"><em>Declared by:</em></span></p>
-<table border="0" summary="Simple list" class="simplelist">
-<tr><td>
-<code class="filename"><a class="filename"  href="https://github.com/NotAShelf/nvf/blob/main/modules/wrapper/rc/options.nix" target="_top">
-&lt;nvf/modules/wrapper/rc/options.nix&gt;
-</a></code>
-</td></tr>
-</table>
-</dd>
-<dt>
- <span class="term">
- <a id="opt-vim.options.signcolumn"></a><a class="term" href="options.html#opt-vim.options.signcolumn"><code class="option">vim.options.signcolumn</code>
-  </a>
- </span>
-</dt>
-<dd>
-<p>Show the sign column</p>
-
-<p><span class="emphasis"><em>Type:</em></span>
-string or boolean</p>
-
-<p><span class="emphasis"><em>Default:</em></span>
-<code class="literal">true</code></p>
-
 <p><span class="emphasis"><em>Declared by:</em></span></p>
 <table border="0" summary="Simple list" class="simplelist">
 <tr><td>
@@ -24758,6 +24750,30 @@ boolean</p>
 </td></tr>
 </table>
 </dd>
+<dt>
+ <span class="term">
+ <a id="opt-vim.showSignColumn"></a><a class="term" href="options.html#opt-vim.showSignColumn"><code class="option">vim.showSignColumn</code>
+  </a>
+ </span>
+</dt>
+<dd>
+<p>Show the sign column</p>
+
+<p><span class="emphasis"><em>Type:</em></span>
+boolean</p>
+
+<p><span class="emphasis"><em>Default:</em></span>
+<code class="literal">true</code></p>
+
+<p><span class="emphasis"><em>Declared by:</em></span></p>
+<table border="0" summary="Simple list" class="simplelist">
+<tr><td>
+<code class="filename"><a class="filename"  href="https://github.com/NotAShelf/nvf/blob/main/modules/neovim/init/basic.nix" target="_top">
+&lt;nvf/modules/neovim/init/basic.nix&gt;
+</a></code>
+</td></tr>
+</table>
+</dd>
 <dt>
  <span class="term">
  <a id="opt-vim.snippets.luasnip.enable"></a><a class="term" href="options.html#opt-vim.snippets.luasnip.enable"><code class="option">vim.snippets.luasnip.enable</code>

release-notes.html

@@ -236,11 +236,11 @@ slightly changed. See the new <a class="link" href="/index.xhtml#ch-dag-entries"
 making good use of its extensive Lua API. Additionally, Vimscript is slow and
 brings unnecessary performance overhead while working with different
 configuration formats.</p>
-</div><div class="section"> <div class="titlepage">  <div>   <div>    <h3 id="sec-vim-maps-rewrite" class="title" ><code class="literal">vim.maps</code> rewrite   </h3>  </div> </div></div><p>Instead of specifying map modes using submodules (e.g.: <code class="literal">vim.maps.normal</code>), a
+</div><div class="section"> <div class="titlepage">  <div>   <div>    <h3 id="sec-vim-maps-rewrite" class="title" ><code class="literal">vim.maps</code> rewrite   </h3>  </div> </div></div><p>Instead of specifying map modes using submodules (eg.: <code class="literal">vim.maps.normal</code>), a new
-new <code class="literal">vim.keymaps</code> submodule with support for a <code class="literal">mode</code> option has been
+<code class="literal">vim.keymaps</code> submodule with support for a <code class="literal">mode</code> option has been introduced. It
-introduced. It can be either a string, or a list of strings, where a string
+can be either a string, or a list of strings, where a string represents the
-represents the short-name of the map mode(s), that the mapping should be set
+short-name of the map mode(s), that the mapping should be set for. See
-for. See <code class="literal">:help map-modes</code> for more information.</p><p>For example:</p><pre><code class="programlisting nix">vim.maps.normal.&quot;&lt;leader&gt;m&quot; = { ... };
+<code class="literal">:help map-modes</code> for more information.</p><p>For example:</p><pre><code class="programlisting nix">vim.maps.normal.&quot;&lt;leader&gt;m&quot; = { ... };
 </code></pre><p>has to be replaced by</p><pre><code class="programlisting nix">vim.keymaps = [
   {
     key = &quot;&lt;leader&gt;m&quot;;