nix/11.stylix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

nixvim: move standalone-mode docs from configuration → nixvim readme (#1219)

Browse source 
Link: https://github.com/danth/stylix/pull/1219

Reviewed-by: awwpotato <awwpotato@voidq.com>
Reviewed-by: Flameopathic <64027365+Flameopathic@users.noreply.github.com>
This commit is contained in:
Matt Sturgeon 2025-05-04 17:54:32 +01:00 • committed by GitHub
parent fa5a34e7b1
commit 003e6770af
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 35 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

33
docs/src/configuration.md
View file

@ -195,35 +195,12 @@ to customize this.
## Standalone Nixvim
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.
<!--
NOTE: you can't redirect from a heading #anchor using [output.html.redirect]
TODO: Drop this redirect link after a while (added 2025-05-04)
-->
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 ];
}
```
[Nixvim]: https://nix-community.github.io/nixvim
[Nixvim Standalone]: https://nix-community.github.io/nixvim/user-guide/install.html#standalone-usage
See [Modules → NixVim → Standalone Mode](./options/modules/nixvim.md#standalone-mode).
## Turning targets on and off

30
modules/nixvim/README.md
View file

@ -12,6 +12,35 @@ This module themes [Neovim] using the options provided by [NixVim].
> 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. -->
@ -22,4 +51,5 @@ This module themes [Neovim] using the options provided by [NixVim].
[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