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

doc: add note for user-imported modules (#1039)

Browse source 
Adds basic documentation to every Stylix module which requires a
user-imported module to function.

Intended to prevent issues like #1033
This commit is contained in:
Flameopathic 2025-03-21 17:11:03 -04:00 • committed by GitHub
parent 7e9906679d
commit 113643f332
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 41 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
modules/discord/README.md Normal file
View file

@ -0,0 +1,9 @@
# Discord
## Nixcord
This Stylix module leverages the modules provided the
[Nixcord flake](https://github.com/KaylorBen/nixcord). Ensure that the Nixcord
Home Manager module is properly
[imported](https://github.com/KaylorBen/nixcord?tab=readme-ov-file#how-to-use-nixcord)
into your user configuration if you wish for the Stylix module to function.

11
modules/nixvim/README.md Normal file
View file

@ -0,0 +1,11 @@
# Nixvim
This Stylix module leverages the modules provided by
[Nixvim](https://github.com/nix-community/nixvim). Ensure that 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 user configuration. When configuring `stylix.targets.nixvim` options,
ensure that you are configuring them in the same scope (NixOS, Home Manager,
Darwin) as you imported the Nixvim module.

10
modules/nvf/README.md Normal file
View file

@ -0,0 +1,10 @@
# NVF
This Stylix module leverages the modules provided by
[NVF](https://github.com/NotAShelf/nvf). Ensure that the desired NVF module is
properly
[installed](https://notashelf.github.io/nvf/index.xhtml#ch-installation) and
[imported](https://notashelf.github.io/nvf/index.xhtml#ch-module-installation)
into your user configuration. When configuring `stylix.targets.nvf` options,
ensure that you are configuring them in the same scope (NixOS, Home Manager,
Darwin) as you imported the NVF module.

11
modules/spicetify/README.md Normal file
View file

@ -0,0 +1,11 @@
# Spicetify
This Stylix module leverages the modules provided by
[Spicetify-Nix](https://github.com/Gerg-L/spicetify-nix). Ensure that the
desired Spicetify module is properly
[installed](https://github.com/Gerg-L/spicetify-nix?tab=readme-ov-file#usage)
and
[imported](https://github.com/Gerg-L/spicetify-nix?tab=readme-ov-file#modules)
into your user configuration. When configuring `stylix.targets.spicetify`
options, ensure that you are configuring them in the same scope (NixOS,
Home Manager, Darwin) as you imported the Spicetify module.