docs/options: include warning about option prefix

This commit is contained in:
raf 2024-11-07 15:16:53 +03:00
parent 38f534f6d8
commit ffbcebbb4e
Signed by: NotAShelf
GPG key ID: AF26552424E53993

View file

@ -1,8 +1,14 @@
# Neovim Flake Configuration Options {#ch-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.
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
option is meant to be used as well as examples in complex cases.
<!--
In the manual, individual options may be referenced in Hyperlinks as follows:
[](#opt-vim.*) If changing the prefix here, do keep in mind the #opt- suffix will have
to be changed everywhere.
-->
```{=include=} options
id-prefix: opt-