nix-community/nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-12-16 05:51:10 +01:00
Code Activity

docs: use official names of NixOS, Home Manager and nix-darwin

Browse source
This commit is contained in:
Axel Karjalainen 2025-10-17 19:39:25 +03:00 • committed by Matt Sturgeon
parent e006fa229c
commit 4c4cac6445
11 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/user-guide/faq.md
View file

@ -90,7 +90,7 @@ This usually means one of two things:
When building nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`.
This is so that nixvim is built against the same nixpkgs revision we're using in our test suite.
If you are building nixvim using the NixOS, home-manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours.
If you are building nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours.
> [!TIP]
> Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system.

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

@ -11,7 +11,7 @@ Failure to use the correct branch, or an old revision of nixpkgs will likely res
NixVim can be used in four ways:
- As a NixOS module
- As a Home-Manager module
- As a Home Manager module
- As a nix-darwin module
- As a standalone derivation
@ -45,14 +45,14 @@ When using flakes you can simply add `nixvim` to the inputs:
## Usage
NixVim can be used standalone or as a module for NixOS, home-manager, or nix-darwin.
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)
### 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.
The three imports are:
@ -92,7 +92,7 @@ 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 if you use nixvim both as part of an environment and standalone.
For more platform-specific options and information, see [Nixvim Platforms](../platforms/index.md).