mirror of
https://github.com/nix-community/nixvim.git
synced 2025-08-05 02:26:15 +02:00
342161bf52
This template uses the lower-level `evalNixvim` function to work directly with nixvim configurations, instead of the prior idiom of using `makeNixvim` to produce nixvim packages. Additionally, the template is build on flake.parts, and demonstrates using our recently added flakeModules.
31 lines
1 KiB
Markdown
31 lines
1 KiB
Markdown
# New Nixvim template
|
|
|
|
This template gives you a good starting point for configuring nixvim as a standalone module configuration.
|
|
|
|
## Configuring
|
|
|
|
To start configuring, just add or modify the module files in `./config`.
|
|
If you add new modules, remember to import them in [`./config/default.nix`](./config/default.nix).
|
|
|
|
## Using your vim configuration
|
|
|
|
To use your configuration simply run the following command
|
|
|
|
```
|
|
nix run
|
|
```
|
|
|
|
## Configurations and packages
|
|
|
|
Your nixvim configuration is created using `evalNixvim`.
|
|
This is outputted as the `nixvimConfigurations.<system>.default` flake output.
|
|
|
|
You can access your configuration's package outputs `<configuration>.config.build.package`.
|
|
This is exported as the flake output `packages.<system>.default`.
|
|
This package can be run using `nix run`.
|
|
|
|
A test is also available as `<configuration>.config.build.test`.
|
|
This is exported as the flake output `checks.<system>.default`.
|
|
This test can be run using `nix flake check`.
|
|
|
|
<!-- TODO: figure out how to _wrap_ an existing configuration as a nixos/hm module -->
|