mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs/user-guide: document nixvim's lib overlay

Browse source
This commit is contained in:
Matt Sturgeon 2025-01-17 00:13:26 +00:00
parent b28ebf2535
commit c19daee453
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 32 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/user-guide/helpers.md
View file

@ -39,6 +39,36 @@ This "extended" lib, includes everything normally in `lib`, along with some addi
**Note:** the `lib` argument passed to modules is entirely unrelated to the `lib` _option_ accessed as `config.lib`!
## Using a custom `lib` with Nixvim
When Nixvim is built in standalone mode, it expects `lib` to have Nixvim's extensions.
If you'd like to use a `lib` with your own extensions, you must supply it via `specialArgs`,
however you must ensure Nixvim's extensions are also present.
This can be achieved using the lib overlay, available via the `<nixvim>.lib.overlay` flake output.
```nix
# Example flake
{
inputs = {
# ...
};
outputs =
{ nixpkgs, ... }@inputs:
let
lib = import (nixpkgs + "/lib");
myCustomLib = lib.extend (final: prev: {
# ...
});
myCustomLibForNixvim = myCustomLib.extend inputs.nixvim.lib.overlay;
in
{
# ...
};
}
```
## Common helper functions
A certain number of helpers are defined that can be useful: