docs/manual: release TOC depth
Some checks failed
Check for typos in the source tree / check-typos (push) Has been cancelled

This commit is contained in:
raf 2025-02-03 15:18:27 +03:00
parent c9ac830a2d
commit 7443f0a470
No known key found for this signature in database
GPG key ID: EED98D11B85A2819
3 changed files with 10 additions and 15 deletions

View file

@ -102,7 +102,7 @@ in
--script script/anchor-use.js \ --script script/anchor-use.js \
--script script/anchor-min.js \ --script script/anchor-min.js \
--script script/search.js \ --script script/search.js \
--toc-depth 2 \ --toc-depth 1 \
--section-toc-depth 1 \ --section-toc-depth 1 \
manual.md \ manual.md \
"$dest/index.xhtml" "$dest/index.xhtml"

View file

@ -1,4 +1,4 @@
# Neovim Flake Configuration Options {#ch-options} # nvf Configuration Options {#ch-options}
Below are the module options provided by nvf, in no particular order. Most Below are the module options provided by nvf, in no particular order. Most
options will include useful comments, warnings or setup tips on how a module options will include useful comments, warnings or setup tips on how a module

View file

@ -1,4 +1,4 @@
# Pure Lua Configuration {#pure-lua-config} # Pure Lua Configuration {#sec-pure-lua-config}
We recognize that you might not always want to configure your setup purely in We recognize that you might not always want to configure your setup purely in
Nix, sometimes doing things in Lua is simply the "superior" option. In such a Nix, sometimes doing things in Lua is simply the "superior" option. In such a
@ -6,15 +6,15 @@ case you might want to configure your Neovim instance using Lua, and nothing but
Lua. It is also possible to mix Lua and Nix configurations through the following Lua. It is also possible to mix Lua and Nix configurations through the following
method. method.
## Custom Configuration Directory {#custom-config-dir} ## Custom Configuration Directory {#sec-custom-config-dir}
[Neovim 0.9]: https://github.com/neovim/neovim/pull/22128 [Neovim 0.9]: https://github.com/neovim/neovim/pull/22128
As of [Neovim 0.9], `$NVIM_APPNAME` is a variable expected by Neovim to decide As of [Neovim 0.9], {var}`$NVIM_APPNAME` is a variable expected by Neovim to
on the configuration directory. nvf sets this variable as `"nvf"`, meaning decide on the configuration directory. nvf sets this variable as `"nvf"`,
`~/.config/nvf` will be regarded as _the_ configuration directory by Neovim, meaning `~/.config/nvf` will be regarded as _the_ configuration directory by
similar to how `~/.config/nvim` behaves in regular installations. This allows Neovim, similar to how `~/.config/nvim` behaves in regular installations. This
some degree[^1] of Lua configuration, backed by our low-level wrapper allows some degree of Lua configuration, backed by our low-level wrapper
[mnw](https://github.com/Gerg-L/mnw). Creating a `lua/` directory located in [mnw](https://github.com/Gerg-L/mnw). Creating a `lua/` directory located in
`$NVIM_APPNAME` ("nvf" by default) and placing your configuration in, e.g., `$NVIM_APPNAME` ("nvf" by default) and placing your configuration in, e.g.,
`~/.config/nvf/lua/myconfig` will allow you to `require` it as a part of the Lua `~/.config/nvf/lua/myconfig` will allow you to `require` it as a part of the Lua
@ -24,6 +24,7 @@ Let's assume your `~/.config/nvf/lua/myconfig/init.lua` consists of the
following: following:
```lua ```lua
-- init.lua
vim.keymap.set("n", " ", "<Nop>", { silent = true, remap = false }) vim.keymap.set("n", " ", "<Nop>", { silent = true, remap = false })
vim.g.mapleader = " " vim.g.mapleader = " "
``` ```
@ -53,9 +54,3 @@ specific position (i.e., before or after options you set in nvf) the
choosing. choosing.
[top-level DAG system]: https://notashelf.github.io/nvf/index.xhtml#ch-vim-luaconfigrc [top-level DAG system]: https://notashelf.github.io/nvf/index.xhtml#ch-vim-luaconfigrc
[^1]: You might sometimes face "overrides" set by nvf. Those should be very
rare, and almost always exclusive to `vim.globals` or `vim.options`. In such
a case, simply placing the `require` call for your configuration _after_
`optionsScript` in the [top-level DAG system] will allow you to override
previous options.