mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-20 16:15:43 +02:00
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:
parent
2258eb8df8
commit
c5f31f5677
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
@ -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:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue