NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-12-19 02:11:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/manual: add more details to existing documentation pages

Browse source
This commit is contained in:
raf 2023-10-03 22:06:26 +03:00
commit 0c848869cf
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
7 changed files with 131 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/manual/custom-configs.adoc
View file

@ -1,7 +1,8 @@
[[ch-custom-configuration]]
== Custom Configuration
Custom configuration is done with the `neovimConfiguration` function. It takes in the configuration as a module. The output of the configuration function is an attrset.
Custom configuration is done with the `neovimConfiguration` while using the flake as a standalone package.
It takes in the configuration as a module. The output of the configuration function is an attrset.
[source,nix]
----
@ -40,8 +41,28 @@ The following is an example of a barebones vim configuration with the default th
inherit pkgs;
};
in {
# this will make the package available as a flake input
packages.${system}.neovim = customNeovim.neovim;
# this is an example nixosConfiguration using the built neovim package
nixosConfigurations = {
yourHostName = nixpkgs.lib.nixosSystem {
# ...
modules = [
./configuration.nix # or whatever your configuration is
# this will make wrapped neovim available in your system packages
{environment.systemPackages = [customNeovim.neovim];}
];
# ...
};
};
};
}
----
Your built neovim configuration can be exposed as a flake output, or be added to your system packages to make
it available across your system. You may also consider passing the flake output to home-manager to make it available
to a specific user *without* using the home-manager module.