From 82f67a36eba1b111f8d568bf5e5ceb30e4b623d6 Mon Sep 17 00:00:00 2001 From: Flameopathic <64027365+Flameopathic@users.noreply.github.com> Date: Thu, 10 Apr 2025 02:45:51 -0400 Subject: [PATCH] doc: align module capitalization (#1115) Closes: https://github.com/danth/stylix/issues/1084 Link: https://github.com/danth/stylix/pull/1115 Reviewed-by: NAHO <90870942+trueNAHO@users.noreply.github.com> Reviewed-by: Daniel Thwaites Reviewed-by: awwpotato <153149335+awwpotato@users.noreply.github.com> --- docs/default.nix | 22 +++++++++++++++++++--- docs/src/modules.md | 13 ++++++++++--- modules/alacritty/meta.nix | 1 + modules/avizo/meta.nix | 1 + modules/bat/meta.nix | 1 + modules/bemenu/meta.nix | 1 + modules/bspwm/meta.nix | 1 + modules/btop/meta.nix | 1 + modules/cava/meta.nix | 1 + modules/cavalier/meta.nix | 1 + modules/chromium/meta.nix | 1 + modules/console/meta.nix | 1 + modules/discord/meta.nix | 1 + modules/dunst/meta.nix | 1 + modules/emacs/meta.nix | 1 + modules/eog/meta.nix | 1 + modules/fcitx5/meta.nix | 1 + modules/feh/meta.nix | 1 + modules/firefox/meta.nix | 1 + modules/fish/meta.nix | 1 + modules/fnott/meta.nix | 1 + modules/foot/meta.nix | 1 + modules/forge/meta.nix | 1 + modules/fuzzel/meta.nix | 1 + modules/fzf/meta.nix | 1 + modules/gedit/meta.nix | 1 + modules/ghostty/meta.nix | 1 + modules/gitui/meta.nix | 1 + modules/glance/meta.nix | 1 + modules/gnome-text-editor/meta.nix | 1 + modules/gnome/meta.nix | 1 + modules/grub/meta.nix | 1 + modules/gtk/meta.nix | 1 + modules/halloy/meta.nix | 1 + modules/helix/meta.nix | 1 + modules/hyprland/meta.nix | 1 + modules/hyprlock/meta.nix | 1 + modules/hyprpaper/meta.nix | 1 + modules/i3/meta.nix | 1 + modules/i3status-rust/meta.nix | 1 + modules/k9s/meta.nix | 1 + modules/kde/meta.nix | 1 + modules/kitty/meta.nix | 1 + modules/kmscon/meta.nix | 1 + modules/kubecolor/meta.nix | 1 + modules/lazygit/meta.nix | 1 + modules/lightdm/meta.nix | 1 + modules/mako/meta.nix | 1 + modules/mangohud/meta.nix | 1 + modules/micro/meta.nix | 1 + modules/mpv/meta.nix | 1 + modules/ncspot/meta.nix | 1 + modules/neovim/README.md | 4 ++-- modules/neovim/meta.nix | 1 + modules/nixos-icons/meta.nix | 1 + modules/nixvim/README.md | 10 +++++----- modules/nixvim/meta.nix | 1 + modules/nushell/meta.nix | 1 + modules/nvf/README.md | 10 +++++----- modules/nvf/meta.nix | 1 + modules/plymouth/meta.nix | 1 + modules/qt/meta.nix | 1 + modules/qutebrowser/meta.nix | 1 + modules/regreet/meta.nix | 1 + modules/rio/meta.nix | 1 + modules/river/meta.nix | 1 + modules/rofi/meta.nix | 1 + modules/spicetify/meta.nix | 1 + modules/starship/meta.nix | 1 + modules/sway/meta.nix | 1 + modules/swaylock/meta.nix | 1 + modules/swaync/meta.nix | 1 + modules/sxiv/meta.nix | 1 + modules/tmux/meta.nix | 1 + modules/tofi/meta.nix | 1 + modules/vim/README.md | 4 ++-- modules/vim/meta.nix | 1 + modules/vscode/meta.nix | 1 + modules/waybar/meta.nix | 1 + modules/wayfire/meta.nix | 1 + modules/wezterm/meta.nix | 1 + modules/wob/meta.nix | 1 + modules/wofi/meta.nix | 1 + modules/wpaperd/meta.nix | 1 + modules/xfce/meta.nix | 1 + modules/xresources/meta.nix | 1 + modules/yazi/meta.nix | 1 + modules/zathura/meta.nix | 1 + modules/zed/meta.nix | 1 + modules/zellij/meta.nix | 1 + 90 files changed, 127 insertions(+), 20 deletions(-) diff --git a/docs/default.nix b/docs/default.nix index 6fe0f9b4..602e4ef1 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -134,18 +134,34 @@ let path = "${inputs.self}/modules/${module}/README.md"; # This doesn't count as IFD because ${inputs.self} is a flake input + # + # In addition, this checks that the README.md starts with an + # appropriate title mainText = + let + name = lib.throwIfNot ( + metadata ? ${module}.name + ) "stylix: ${module} is missing `meta.name`" metadata.${module}.name; + in if builtins.pathExists path then - builtins.readFile path + let + text = builtins.readFile path; + in + lib.throwIfNot ( + (builtins.head (lib.splitString "\n" text)) == "# ${name}" + ) "README.md of ${name} must have a title which matches its `meta.name`" text else '' - # ${module} + # ${name} > [!NOTE] > This module doesn't include any additional documentation. > You can browse the options it provides below. ''; - inherit (metadata.${module}) maintainers; + maintainers = + lib.throwIfNot (metadata ? ${module}.maintainers) + "stylix: ${module} is missing `meta.maintainers`" + metadata.${module}.maintainers; # Render a maintainer's name and a link to the best contact # information we have for them. diff --git a/docs/src/modules.md b/docs/src/modules.md index 46fbf15b..153e62ee 100644 --- a/docs/src/modules.md +++ b/docs/src/modules.md @@ -145,10 +145,17 @@ slow and should be avoided. For everything else, like fonts and wallpapers, you can just take option values directly from `config`. See the reference pages for a list of options. -## Maintainers +## Metadata -New modules must have at least one maintainer defined in -`/modules/«module»/meta.nix`. +Metadata is stored in `/modules/«module»/meta.nix`. The following attributes are +available under `meta`: + +- `maintainers`: required list of maintainers. See [Maintainers](#maintainers) section. +- `name`: required human-readable string name. + +### Maintainers + +New modules must have at least one maintainer. If you are not already listed in the Nixpkgs `/maintainers/maintainer-list.nix` maintainer list, add yourself to `/stylix/maintainers.nix`. diff --git a/modules/alacritty/meta.nix b/modules/alacritty/meta.nix index 51e10e61..a6bc39df 100644 --- a/modules/alacritty/meta.nix +++ b/modules/alacritty/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Alacritty"; } diff --git a/modules/avizo/meta.nix b/modules/avizo/meta.nix index 51e10e61..155b7ef4 100644 --- a/modules/avizo/meta.nix +++ b/modules/avizo/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Avizo"; } diff --git a/modules/bat/meta.nix b/modules/bat/meta.nix index 51e10e61..f25e86e4 100644 --- a/modules/bat/meta.nix +++ b/modules/bat/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "bat"; } diff --git a/modules/bemenu/meta.nix b/modules/bemenu/meta.nix index 51e10e61..47bac5e1 100644 --- a/modules/bemenu/meta.nix +++ b/modules/bemenu/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "bemenu"; } diff --git a/modules/bspwm/meta.nix b/modules/bspwm/meta.nix index 51e10e61..2a886834 100644 --- a/modules/bspwm/meta.nix +++ b/modules/bspwm/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "bspwm"; } diff --git a/modules/btop/meta.nix b/modules/btop/meta.nix index 51e10e61..92476107 100644 --- a/modules/btop/meta.nix +++ b/modules/btop/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "btop"; } diff --git a/modules/cava/meta.nix b/modules/cava/meta.nix index 51e10e61..367ea01c 100644 --- a/modules/cava/meta.nix +++ b/modules/cava/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Cava"; } diff --git a/modules/cavalier/meta.nix b/modules/cavalier/meta.nix index 51e10e61..9c9a5090 100644 --- a/modules/cavalier/meta.nix +++ b/modules/cavalier/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Cavalier"; } diff --git a/modules/chromium/meta.nix b/modules/chromium/meta.nix index 51e10e61..e5ed3b91 100644 --- a/modules/chromium/meta.nix +++ b/modules/chromium/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Chromium"; } diff --git a/modules/console/meta.nix b/modules/console/meta.nix index 51e10e61..687ee85b 100644 --- a/modules/console/meta.nix +++ b/modules/console/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "kernel console"; } diff --git a/modules/discord/meta.nix b/modules/discord/meta.nix index 7cbf701a..e3e0287e 100644 --- a/modules/discord/meta.nix +++ b/modules/discord/meta.nix @@ -1,4 +1,5 @@ { lib, ... }: { maintainers = [ lib.maintainers.Flameopathic ]; + name = "Discord"; } diff --git a/modules/dunst/meta.nix b/modules/dunst/meta.nix index 51e10e61..76889f2a 100644 --- a/modules/dunst/meta.nix +++ b/modules/dunst/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Dunst"; } diff --git a/modules/emacs/meta.nix b/modules/emacs/meta.nix index 51e10e61..60759ce4 100644 --- a/modules/emacs/meta.nix +++ b/modules/emacs/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Emacs"; } diff --git a/modules/eog/meta.nix b/modules/eog/meta.nix index 51e10e61..074e5f92 100644 --- a/modules/eog/meta.nix +++ b/modules/eog/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Eye of GNOME"; } diff --git a/modules/fcitx5/meta.nix b/modules/fcitx5/meta.nix index 51e10e61..202ec35f 100644 --- a/modules/fcitx5/meta.nix +++ b/modules/fcitx5/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Fcitx 5"; } diff --git a/modules/feh/meta.nix b/modules/feh/meta.nix index 51e10e61..29546804 100644 --- a/modules/feh/meta.nix +++ b/modules/feh/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "feh"; } diff --git a/modules/firefox/meta.nix b/modules/firefox/meta.nix index 7cbf701a..2e261be9 100644 --- a/modules/firefox/meta.nix +++ b/modules/firefox/meta.nix @@ -1,4 +1,5 @@ { lib, ... }: { maintainers = [ lib.maintainers.Flameopathic ]; + name = "Firefox and its derivatives"; } diff --git a/modules/fish/meta.nix b/modules/fish/meta.nix index 51e10e61..f157300c 100644 --- a/modules/fish/meta.nix +++ b/modules/fish/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "fish"; } diff --git a/modules/fnott/meta.nix b/modules/fnott/meta.nix index 51e10e61..2a04614a 100644 --- a/modules/fnott/meta.nix +++ b/modules/fnott/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Fnott"; } diff --git a/modules/foot/meta.nix b/modules/foot/meta.nix index 51e10e61..c18af727 100644 --- a/modules/foot/meta.nix +++ b/modules/foot/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "foot"; } diff --git a/modules/forge/meta.nix b/modules/forge/meta.nix index 51e10e61..95812409 100644 --- a/modules/forge/meta.nix +++ b/modules/forge/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Forge"; } diff --git a/modules/fuzzel/meta.nix b/modules/fuzzel/meta.nix index 51e10e61..e57a56f0 100644 --- a/modules/fuzzel/meta.nix +++ b/modules/fuzzel/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Fuzzel"; } diff --git a/modules/fzf/meta.nix b/modules/fzf/meta.nix index 51e10e61..7562b8e6 100644 --- a/modules/fzf/meta.nix +++ b/modules/fzf/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "fzf"; } diff --git a/modules/gedit/meta.nix b/modules/gedit/meta.nix index 51e10e61..ed26b5cb 100644 --- a/modules/gedit/meta.nix +++ b/modules/gedit/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "gedit"; } diff --git a/modules/ghostty/meta.nix b/modules/ghostty/meta.nix index 51e10e61..6b844056 100644 --- a/modules/ghostty/meta.nix +++ b/modules/ghostty/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Ghostty"; } diff --git a/modules/gitui/meta.nix b/modules/gitui/meta.nix index 51e10e61..646c86fb 100644 --- a/modules/gitui/meta.nix +++ b/modules/gitui/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "GitUI"; } diff --git a/modules/glance/meta.nix b/modules/glance/meta.nix index 51e10e61..74892244 100644 --- a/modules/glance/meta.nix +++ b/modules/glance/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Glance"; } diff --git a/modules/gnome-text-editor/meta.nix b/modules/gnome-text-editor/meta.nix index 51e10e61..98f933c5 100644 --- a/modules/gnome-text-editor/meta.nix +++ b/modules/gnome-text-editor/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "GNOME Text Editor"; } diff --git a/modules/gnome/meta.nix b/modules/gnome/meta.nix index 51e10e61..b8bee2e4 100644 --- a/modules/gnome/meta.nix +++ b/modules/gnome/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "GNOME"; } diff --git a/modules/grub/meta.nix b/modules/grub/meta.nix index 51e10e61..3fd716c0 100644 --- a/modules/grub/meta.nix +++ b/modules/grub/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "GRUB"; } diff --git a/modules/gtk/meta.nix b/modules/gtk/meta.nix index 51e10e61..2336224d 100644 --- a/modules/gtk/meta.nix +++ b/modules/gtk/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "GTK"; } diff --git a/modules/halloy/meta.nix b/modules/halloy/meta.nix index 51e10e61..c68c43a5 100644 --- a/modules/halloy/meta.nix +++ b/modules/halloy/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Halloy"; } diff --git a/modules/helix/meta.nix b/modules/helix/meta.nix index 51e10e61..c6116743 100644 --- a/modules/helix/meta.nix +++ b/modules/helix/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Helix"; } diff --git a/modules/hyprland/meta.nix b/modules/hyprland/meta.nix index 51e10e61..3a3d33d4 100644 --- a/modules/hyprland/meta.nix +++ b/modules/hyprland/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Hyprland"; } diff --git a/modules/hyprlock/meta.nix b/modules/hyprlock/meta.nix index 51e10e61..0cfd337e 100644 --- a/modules/hyprlock/meta.nix +++ b/modules/hyprlock/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "hyprlock"; } diff --git a/modules/hyprpaper/meta.nix b/modules/hyprpaper/meta.nix index 51e10e61..1c9bb1f0 100644 --- a/modules/hyprpaper/meta.nix +++ b/modules/hyprpaper/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "hyprpaper"; } diff --git a/modules/i3/meta.nix b/modules/i3/meta.nix index 51e10e61..a2a929b2 100644 --- a/modules/i3/meta.nix +++ b/modules/i3/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "i3"; } diff --git a/modules/i3status-rust/meta.nix b/modules/i3status-rust/meta.nix index 51e10e61..18576789 100644 --- a/modules/i3status-rust/meta.nix +++ b/modules/i3status-rust/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "i3status-rust"; } diff --git a/modules/k9s/meta.nix b/modules/k9s/meta.nix index d3b3a7a3..4cfaa92a 100644 --- a/modules/k9s/meta.nix +++ b/modules/k9s/meta.nix @@ -1,4 +1,5 @@ { lib, ... }: { maintainers = [ lib.maintainers.cluther ]; + name = "K9s"; } diff --git a/modules/kde/meta.nix b/modules/kde/meta.nix index 51e10e61..d3f30f16 100644 --- a/modules/kde/meta.nix +++ b/modules/kde/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "KDE"; } diff --git a/modules/kitty/meta.nix b/modules/kitty/meta.nix index 51e10e61..8ed39fd8 100644 --- a/modules/kitty/meta.nix +++ b/modules/kitty/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "kitty"; } diff --git a/modules/kmscon/meta.nix b/modules/kmscon/meta.nix index 51e10e61..8df29687 100644 --- a/modules/kmscon/meta.nix +++ b/modules/kmscon/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Kmscon"; } diff --git a/modules/kubecolor/meta.nix b/modules/kubecolor/meta.nix index 51e10e61..f84f3dd2 100644 --- a/modules/kubecolor/meta.nix +++ b/modules/kubecolor/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Kubecolor"; } diff --git a/modules/lazygit/meta.nix b/modules/lazygit/meta.nix index 51e10e61..34b89ee0 100644 --- a/modules/lazygit/meta.nix +++ b/modules/lazygit/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Lazygit"; } diff --git a/modules/lightdm/meta.nix b/modules/lightdm/meta.nix index 51e10e61..baa5b2c3 100644 --- a/modules/lightdm/meta.nix +++ b/modules/lightdm/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "LightDM"; } diff --git a/modules/mako/meta.nix b/modules/mako/meta.nix index 51e10e61..e595c4c3 100644 --- a/modules/mako/meta.nix +++ b/modules/mako/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "mako"; } diff --git a/modules/mangohud/meta.nix b/modules/mangohud/meta.nix index 51e10e61..b5d23819 100644 --- a/modules/mangohud/meta.nix +++ b/modules/mangohud/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "MangoHud"; } diff --git a/modules/micro/meta.nix b/modules/micro/meta.nix index 51e10e61..161d3371 100644 --- a/modules/micro/meta.nix +++ b/modules/micro/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "micro"; } diff --git a/modules/mpv/meta.nix b/modules/mpv/meta.nix index 51e10e61..0eba429a 100644 --- a/modules/mpv/meta.nix +++ b/modules/mpv/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "mpv"; } diff --git a/modules/ncspot/meta.nix b/modules/ncspot/meta.nix index 51e10e61..fa205092 100644 --- a/modules/ncspot/meta.nix +++ b/modules/ncspot/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "ncspot"; } diff --git a/modules/neovim/README.md b/modules/neovim/README.md index b8757987..20aca0a8 100644 --- a/modules/neovim/README.md +++ b/modules/neovim/README.md @@ -8,8 +8,8 @@ This module themes [Neovim] using the standard Home Manager options. - [Vim](vim.md): themes Vim using the standard Home Manager options. - [Nixvim](nixvim.md): themes Neovim using the options provided by [Nixvim]. -- [NVF](nvf.md): themes Neovim using the options provided by [NVF]. +- [nvf](nvf.md): themes Neovim using the options provided by [nvf]. [Neovim]: https://neovim.io [Nixvim]: https://github.com/nix-community/nixvim#readme -[NVF]: https://github.com/NotAShelf/nvf#readme +[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/neovim/meta.nix b/modules/neovim/meta.nix index 51e10e61..2ba50962 100644 --- a/modules/neovim/meta.nix +++ b/modules/neovim/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Neovim"; } diff --git a/modules/nixos-icons/meta.nix b/modules/nixos-icons/meta.nix index 51e10e61..af19d510 100644 --- a/modules/nixos-icons/meta.nix +++ b/modules/nixos-icons/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "NixOS Icons"; } diff --git a/modules/nixvim/README.md b/modules/nixvim/README.md index 290f1b1f..2b03cc74 100644 --- a/modules/nixvim/README.md +++ b/modules/nixvim/README.md @@ -1,6 +1,6 @@ -# Nixvim +# NixVim -This module themes [Neovim] using the options provided by [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 @@ -18,8 +18,8 @@ This module themes [Neovim] using the options provided by [Nixvim]. - [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]. +- [nvf](nvf.md): themes Neovim using the options provided by [nvf]. [Neovim]: https://neovim.io -[Nixvim]: https://github.com/nix-community/nixvim#readme -[NVF]: https://github.com/NotAShelf/nvf#readme +[NixVim]: https://github.com/nix-community/nixvim#readme +[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/nixvim/meta.nix b/modules/nixvim/meta.nix index 51e10e61..f34d985d 100644 --- a/modules/nixvim/meta.nix +++ b/modules/nixvim/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "NixVim"; } diff --git a/modules/nushell/meta.nix b/modules/nushell/meta.nix index 51e10e61..e3200b6a 100644 --- a/modules/nushell/meta.nix +++ b/modules/nushell/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Nushell"; } diff --git a/modules/nvf/README.md b/modules/nvf/README.md index a6fa4d7f..3ad3ad97 100644 --- a/modules/nvf/README.md +++ b/modules/nvf/README.md @@ -1,16 +1,16 @@ -# NVF +# nvf -This module themes [Neovim] using the options provided by [NVF]. +This module themes [Neovim] using the options provided by [nvf]. > [!IMPORTANT] -> This module will have no effect unless the desired NVF module is properly +> This module will have no effect unless 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 configuration. > > Ensure you are configuring this module on the same platform (NixOS, Home -> Manager, Darwin) as where you installed NVF. +> Manager, Darwin) as where you installed nvf. ## Related modules @@ -22,4 +22,4 @@ This module themes [Neovim] using the options provided by [NVF]. [Neovim]: https://neovim.io [Nixvim]: https://github.com/nix-community/nixvim#readme -[NVF]: https://github.com/NotAShelf/nvf#readme +[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/nvf/meta.nix b/modules/nvf/meta.nix index 51e10e61..540b6e7c 100644 --- a/modules/nvf/meta.nix +++ b/modules/nvf/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "nvf"; } diff --git a/modules/plymouth/meta.nix b/modules/plymouth/meta.nix index 51e10e61..1667a5dc 100644 --- a/modules/plymouth/meta.nix +++ b/modules/plymouth/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Plymouth"; } diff --git a/modules/qt/meta.nix b/modules/qt/meta.nix index 51e10e61..3a3a600a 100644 --- a/modules/qt/meta.nix +++ b/modules/qt/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Qt"; } diff --git a/modules/qutebrowser/meta.nix b/modules/qutebrowser/meta.nix index 51e10e61..07eca764 100644 --- a/modules/qutebrowser/meta.nix +++ b/modules/qutebrowser/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "qutebrowser"; } diff --git a/modules/regreet/meta.nix b/modules/regreet/meta.nix index 51e10e61..851e74dd 100644 --- a/modules/regreet/meta.nix +++ b/modules/regreet/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "ReGreet"; } diff --git a/modules/rio/meta.nix b/modules/rio/meta.nix index 51e10e61..0b0a9bdc 100644 --- a/modules/rio/meta.nix +++ b/modules/rio/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Rio"; } diff --git a/modules/river/meta.nix b/modules/river/meta.nix index 51e10e61..cd150b4e 100644 --- a/modules/river/meta.nix +++ b/modules/river/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "river"; } diff --git a/modules/rofi/meta.nix b/modules/rofi/meta.nix index 51e10e61..43f1472f 100644 --- a/modules/rofi/meta.nix +++ b/modules/rofi/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Rofi"; } diff --git a/modules/spicetify/meta.nix b/modules/spicetify/meta.nix index 51e10e61..4d4abfa3 100644 --- a/modules/spicetify/meta.nix +++ b/modules/spicetify/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Spicetify"; } diff --git a/modules/starship/meta.nix b/modules/starship/meta.nix index d3b3a7a3..2916a4ed 100644 --- a/modules/starship/meta.nix +++ b/modules/starship/meta.nix @@ -1,4 +1,5 @@ { lib, ... }: { maintainers = [ lib.maintainers.cluther ]; + name = "starship"; } diff --git a/modules/sway/meta.nix b/modules/sway/meta.nix index 51e10e61..916eaf23 100644 --- a/modules/sway/meta.nix +++ b/modules/sway/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Sway"; } diff --git a/modules/swaylock/meta.nix b/modules/swaylock/meta.nix index 51e10e61..48580030 100644 --- a/modules/swaylock/meta.nix +++ b/modules/swaylock/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "swaylock"; } diff --git a/modules/swaync/meta.nix b/modules/swaync/meta.nix index 51e10e61..5e554e20 100644 --- a/modules/swaync/meta.nix +++ b/modules/swaync/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "SwayNotificationCenter"; } diff --git a/modules/sxiv/meta.nix b/modules/sxiv/meta.nix index 51e10e61..1d6721e3 100644 --- a/modules/sxiv/meta.nix +++ b/modules/sxiv/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "sxiv"; } diff --git a/modules/tmux/meta.nix b/modules/tmux/meta.nix index 51e10e61..2f2f876c 100644 --- a/modules/tmux/meta.nix +++ b/modules/tmux/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "tmux"; } diff --git a/modules/tofi/meta.nix b/modules/tofi/meta.nix index 51e10e61..34fd87bf 100644 --- a/modules/tofi/meta.nix +++ b/modules/tofi/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Tofi"; } diff --git a/modules/vim/README.md b/modules/vim/README.md index b52f4c51..159f2fda 100644 --- a/modules/vim/README.md +++ b/modules/vim/README.md @@ -8,8 +8,8 @@ This module themes [Vim] using the standard Home Manager options. - [Neovim](neovim.md): themes Neovim using the standard Home Manager options. - [Nixvim](nixvim.md): themes Neovim using the options provided by [Nixvim]. -- [NVF](nvf.md): themes Neovim using the options provided by [NVF]. +- [nvf](nvf.md): themes Neovim using the options provided by [nvf]. [Vim]: https://www.vim.org [Nixvim]: https://github.com/nix-community/nixvim#readme -[NVF]: https://github.com/NotAShelf/nvf#readme +[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/vim/meta.nix b/modules/vim/meta.nix index 51e10e61..962ff7ac 100644 --- a/modules/vim/meta.nix +++ b/modules/vim/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Vim"; } diff --git a/modules/vscode/meta.nix b/modules/vscode/meta.nix index 7cbf701a..443605c9 100644 --- a/modules/vscode/meta.nix +++ b/modules/vscode/meta.nix @@ -1,4 +1,5 @@ { lib, ... }: { maintainers = [ lib.maintainers.Flameopathic ]; + name = "VSCode"; } diff --git a/modules/waybar/meta.nix b/modules/waybar/meta.nix index 51e10e61..a764ece7 100644 --- a/modules/waybar/meta.nix +++ b/modules/waybar/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Waybar"; } diff --git a/modules/wayfire/meta.nix b/modules/wayfire/meta.nix index 51e10e61..843ae4c7 100644 --- a/modules/wayfire/meta.nix +++ b/modules/wayfire/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Wayfire"; } diff --git a/modules/wezterm/meta.nix b/modules/wezterm/meta.nix index 51e10e61..d0314725 100644 --- a/modules/wezterm/meta.nix +++ b/modules/wezterm/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "WezTerm"; } diff --git a/modules/wob/meta.nix b/modules/wob/meta.nix index 51e10e61..03850e15 100644 --- a/modules/wob/meta.nix +++ b/modules/wob/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "wob"; } diff --git a/modules/wofi/meta.nix b/modules/wofi/meta.nix index 51e10e61..6bb413b8 100644 --- a/modules/wofi/meta.nix +++ b/modules/wofi/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Wofi"; } diff --git a/modules/wpaperd/meta.nix b/modules/wpaperd/meta.nix index 51e10e61..60b4ba55 100644 --- a/modules/wpaperd/meta.nix +++ b/modules/wpaperd/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "wpaperd"; } diff --git a/modules/xfce/meta.nix b/modules/xfce/meta.nix index 51e10e61..7c797934 100644 --- a/modules/xfce/meta.nix +++ b/modules/xfce/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Xfce"; } diff --git a/modules/xresources/meta.nix b/modules/xresources/meta.nix index 51e10e61..4536cc03 100644 --- a/modules/xresources/meta.nix +++ b/modules/xresources/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Xresources file"; } diff --git a/modules/yazi/meta.nix b/modules/yazi/meta.nix index 51e10e61..33217dd0 100644 --- a/modules/yazi/meta.nix +++ b/modules/yazi/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Yazi"; } diff --git a/modules/zathura/meta.nix b/modules/zathura/meta.nix index 51e10e61..73e95981 100644 --- a/modules/zathura/meta.nix +++ b/modules/zathura/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "zathura"; } diff --git a/modules/zed/meta.nix b/modules/zed/meta.nix index 51e10e61..a1ae523d 100644 --- a/modules/zed/meta.nix +++ b/modules/zed/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Zed"; } diff --git a/modules/zellij/meta.nix b/modules/zellij/meta.nix index 51e10e61..0f45ad3d 100644 --- a/modules/zellij/meta.nix +++ b/modules/zellij/meta.nix @@ -1,3 +1,4 @@ { maintainers = [ ]; + name = "Zellij"; }