003e6770af
Link: https://github.com/danth/stylix/pull/1219 Reviewed-by: awwpotato <awwpotato@voidq.com> Reviewed-by: Flameopathic <64027365+Flameopathic@users.noreply.github.com>
55 lines
1.8 KiB
Markdown
55 lines
1.8 KiB
Markdown
# NixVim
|
|
|
|
This module themes [Neovim] using the options provided by [NixVim].
|
|
|
|
> [!IMPORTANT]
|
|
> This module will have no effect unless the desired Nixvim module is properly
|
|
> [installed](https://github.com/nix-community/nixvim?tab=readme-ov-file#installation)
|
|
> and
|
|
> [imported](https://github.com/nix-community/nixvim?tab=readme-ov-file#usage)
|
|
> into your configuration.
|
|
>
|
|
> Ensure you are configuring this module on the same platform (NixOS, Home
|
|
> Manager, Darwin) as where you installed Nixvim.
|
|
|
|
## Standalone Mode
|
|
|
|
When using a NixOS or home-manager installation of [NixVim], you can use Stylix
|
|
as normal. However, when using Nixvim's ["standalone" configuration mode][NixVim Standalone],
|
|
you will need to pass Stylix's generated config to Nixvim yourself.
|
|
|
|
The generated config can be accessed as `config.lib.stylix.nixvim.config`. You
|
|
can use this as a module in your standalone Nixvim Configuration or an
|
|
extension of it.
|
|
|
|
For example:
|
|
|
|
```nix
|
|
{
|
|
inputs,
|
|
config,
|
|
pkgs,
|
|
...
|
|
}:
|
|
let
|
|
inherit (pkgs.stdenv.hostPlatform) system;
|
|
nixvim-package = inputs.nixvim-config.packages.${system}.default;
|
|
extended-nixvim = nixvim-package.extend config.lib.stylix.nixvim.config;
|
|
in
|
|
{
|
|
environment.systemPackages = [ extended-nixvim ];
|
|
}
|
|
```
|
|
|
|
## Related modules
|
|
|
|
<!-- If updating this section, make sure to update it on the linked pages too. -->
|
|
|
|
- [Vim](vim.md): themes Vim using the standard Home Manager options.
|
|
- [Neovim](neovim.md): themes Neovim using the standard Home Manager options.
|
|
- [nvf](nvf.md): themes Neovim using the options provided by [nvf].
|
|
|
|
[Neovim]: https://neovim.io
|
|
[NixVim]: https://github.com/nix-community/nixvim#readme
|
|
[NixVim Standalone]: https://nix-community.github.io/nixvim/user-guide/install.html#standalone-usage
|
|
[nvf]: https://github.com/NotAShelf/nvf#readme
|