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

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

View file

@ -23,10 +23,10 @@ in
extraSpecialArgs ? { },
}:
# Ensure a suitable `lib` is used
# TODO: offer a lib overlay that end-users could use to apply nixvim's extensions to their own `lib`
assert lib.assertMsg (extraSpecialArgs ? lib -> extraSpecialArgs.lib ? nixvim) ''
Nixvim requires a lib that includes some custom extensions, however the `lib` from `specialArgs` does not have a `nixvim` attr.
Remove `lib` from nixvim's `specialArgs` or ensure you apply nixvim's extensions to your `lib`.'';
Remove `lib` from nixvim's `specialArgs` or ensure you apply nixvim's extensions to your `lib`.
See https://nix-community.github.io/nixvim/user-guide/helpers.html#using-a-custom-lib-with-nixvim'';
lib.evalModules {
modules = modules ++ [
../modules/top-level