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

docs: add usage tldr

Browse source
This commit is contained in:
Matt Sturgeon 2024-04-01 13:20:07 +01:00 • committed by Gaétan Lepage
parent 226c555d8f
commit 14fca449b7
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/user-guide/install.md
View file

@ -40,9 +40,19 @@ When using flakes you can simply add `nixvim` to the inputs:
# outputs... # outputs...
} }
``` ```
## Usage as a module (NixOS, Home-Manager, nix-darwin) ## Usage
NixVim can be used standalone or as a module for NixOS, home-manager, or nix-darwin.
When used standalone, a custom NixVim derivation is produced that can be used like any other package.
When used as a module, NixVim can be enabled though `programs.nixvim.enable`.
### Usage as a module (NixOS, home-manager, nix-darwin)
When using NixVim as a module you must import the NixVim module into your module system. When using NixVim as a module you must import the NixVim module into your module system.
The three imports are: The three imports are:
@ -60,7 +70,9 @@ options as `programs.nixvim.<path>.<to>.<option> = <value>`.
When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively. When you use nixvim as a module, an additional module argument is passed on allowing you to peek through the configuration with `hmConfig`, `nixosConfig`, and `darwinConfig` for home-manager, NixOS, and nix-darwin respectively.
This is useful is you use nixvim both as part of an environment and as standalone. This is useful is you use nixvim both as part of an environment and as standalone.
## Standalone usage If using the home-manager module, see [Home Manager Usage](../modules/hm.md) for more information.
### Standalone usage
When using nixvim as a standalone derivation you can use the following functions, located in `<nixvim>.legacyPackages.${system}`: When using nixvim as a standalone derivation you can use the following functions, located in `<nixvim>.legacyPackages.${system}`:
- `makeNixvim`: This function takes an attribute set of options values as arguments - `makeNixvim`: This function takes an attribute set of options values as arguments