Added caveat section to options (#222)

Since the options set could be treated as options for a module, it
should be wrapped with config to work, when using makeNixvimWithModule.
This commit is contained in:
Alexander Nortung 2023-03-04 02:26:13 +00:00 committed by GitHub
parent 2258eb8df8
commit c5f31f5677
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -263,6 +263,20 @@ All of these are configurable from within NixVim. All you have to do is set the
Please note that to, for example, disable numbers you would not set
`options.nonumber` to true, you'd set `options.number` to false.
### Caveats
If you are using `makeNixvimWithModule`, then options is treated as options for a module. To get around this just wrap the options in a `config` set.
```nix
{
config = {
options = {
# ...
};
};
}
```
## Key mappings
It is fully possible to define key mappings from within NixVim. This is done
using the `maps` attribute: