From e2fe2df9b00bf5d65bf17f3d4e77c1a27ad20db8 Mon Sep 17 00:00:00 2001 From: Flameopathic <64027365+Flameopathic@users.noreply.github.com> Date: Sun, 18 May 2025 09:09:50 -0400 Subject: [PATCH] doc: restructure module rendering (#1083) --- docs/default.nix | 86 ++++++++++++++---------------- docs/src/modules.md | 24 ++++++++- modules/alacritty/meta.nix | 3 +- modules/avizo/meta.nix | 3 +- modules/bat/meta.nix | 3 +- modules/bemenu/meta.nix | 3 +- modules/bspwm/meta.nix | 3 +- modules/btop/meta.nix | 3 +- modules/cava/meta.nix | 3 +- modules/cavalier/meta.nix | 3 +- modules/chromium/meta.nix | 3 +- modules/console/meta.nix | 2 +- modules/discord/README.md | 21 -------- modules/discord/meta.nix | 21 +++++++- modules/dunst/meta.nix | 3 +- modules/emacs/meta.nix | 3 +- modules/eog/meta.nix | 3 +- modules/fcitx5/meta.nix | 3 +- modules/feh/meta.nix | 3 +- modules/firefox/README.md | 37 ------------- modules/firefox/meta.nix | 43 ++++++++++++++- modules/fish/meta.nix | 3 +- modules/fnott/meta.nix | 3 +- modules/foot/meta.nix | 3 +- modules/forge/meta.nix | 3 +- modules/fuzzel/meta.nix | 3 +- modules/fzf/meta.nix | 3 +- modules/gedit/meta.nix | 3 +- modules/ghostty/meta.nix | 3 +- modules/gitui/meta.nix | 3 +- modules/glance/meta.nix | 3 +- modules/gnome-text-editor/meta.nix | 3 +- modules/gnome/meta.nix | 3 +- modules/grub/meta.nix | 3 +- modules/gtk/meta.nix | 3 +- modules/halloy/meta.nix | 3 +- modules/helix/meta.nix | 3 +- modules/hyprland/meta.nix | 4 +- modules/hyprlock/meta.nix | 3 +- modules/hyprpaper/meta.nix | 3 +- modules/i3/meta.nix | 3 +- modules/i3status-rust/meta.nix | 3 +- modules/k9s/meta.nix | 3 +- modules/kde/meta.nix | 3 +- modules/kitty/meta.nix | 3 +- modules/kmscon/meta.nix | 3 +- modules/kubecolor/meta.nix | 3 +- modules/lazygit/meta.nix | 4 +- modules/lightdm/meta.nix | 3 +- modules/mako/meta.nix | 3 +- modules/mangohud/meta.nix | 3 +- modules/micro/meta.nix | 3 +- modules/mpv/meta.nix | 4 +- modules/ncspot/meta.nix | 3 +- modules/neovim/README.md | 15 ------ modules/neovim/meta.nix | 18 ++++++- modules/nixos-icons/meta.nix | 3 +- modules/nixvim/README.md | 55 ------------------- modules/nixvim/meta.nix | 58 +++++++++++++++++++- modules/nushell/meta.nix | 3 +- modules/nvf/README.md | 25 --------- modules/nvf/meta.nix | 28 +++++++++- modules/plymouth/meta.nix | 4 +- modules/qt/meta.nix | 3 +- modules/qutebrowser/meta.nix | 3 +- modules/regreet/meta.nix | 3 +- modules/rio/meta.nix | 3 +- modules/river/meta.nix | 3 +- modules/rofi/meta.nix | 3 +- modules/spicetify/README.md | 14 ----- modules/spicetify/meta.nix | 17 +++++- modules/spotify-player/meta.nix | 3 +- modules/starship/meta.nix | 3 +- modules/sway/meta.nix | 3 +- modules/swaylock/meta.nix | 3 +- modules/swaync/meta.nix | 3 +- modules/sxiv/meta.nix | 3 +- modules/tmux/meta.nix | 3 +- modules/tofi/meta.nix | 3 +- modules/vim/README.md | 15 ------ modules/vim/meta.nix | 18 ++++++- modules/vscode/meta.nix | 4 +- modules/waybar/meta.nix | 3 +- modules/wayfire/meta.nix | 3 +- modules/wezterm/meta.nix | 3 +- modules/wob/meta.nix | 3 +- modules/wofi/meta.nix | 3 +- modules/wpaperd/meta.nix | 3 +- modules/xfce/meta.nix | 3 +- modules/xresources/meta.nix | 3 +- modules/yazi/meta.nix | 3 +- modules/zathura/meta.nix | 4 +- modules/zed/meta.nix | 3 +- modules/zellij/meta.nix | 3 +- 94 files changed, 413 insertions(+), 321 deletions(-) delete mode 100644 modules/discord/README.md delete mode 100644 modules/firefox/README.md delete mode 100644 modules/neovim/README.md delete mode 100644 modules/nixvim/README.md delete mode 100644 modules/nvf/README.md delete mode 100644 modules/spicetify/README.md delete mode 100644 modules/vim/README.md diff --git a/docs/default.nix b/docs/default.nix index 6fdeb5b2..f2147ae0 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -138,38 +138,20 @@ let readme = 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 - 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 - '' - # ${name} - > [!NOTE] - > This module doesn't include any additional documentation. - > You can browse the options it provides below. - ''; - maintainers = lib.throwIfNot (metadata ? ${module}.maintainers) "stylix: ${module} is missing `meta.maintainers`" metadata.${module}.maintainers; + joinItems = + items: + if builtins.length items <= 2 then + builtins.concatStringsSep " and " items + else + builtins.concatStringsSep ", " ( + lib.dropEnd 1 items ++ [ "and ${lib.last items}" ] + ); + # Render a maintainer's name and a link to the best contact # information we have for them. # @@ -199,34 +181,46 @@ let else maintainer.name; - joinItems = - items: - if builtins.length items <= 2 then - builtins.concatStringsSep " and " items - else - builtins.concatStringsSep ", " ( - lib.dropEnd 1 items ++ [ "and ${lib.last items}" ] - ); - renderedMaintainers = joinItems (map renderMaintainer maintainers); ghHandles = toString ( map (m: lib.optionalString (m ? github) "@${m.github}") maintainers ); - maintainersText = - if maintainers == [ ] then - "This module has no [dedicated maintainers](../../modules.md#maintainers)." + maintainersText = lib.optionalString ( + maintainers != [ ] + ) "**Maintainers**: ${renderedMaintainers} (`${ghHandles}`)"; + + # Render homepages as hyperlinks in readme + homepage = metadata.${module}.homepage or null; + + renderedHomepages = joinItems ( + lib.mapAttrsToList (name: url: "[${name}](${url})") homepage + ); + + homepageText = + if homepage == null then + "" + else if builtins.isString homepage then + "**Homepage**: [${homepage}](${homepage})\n" + else if builtins.isAttrs homepage then + lib.throwIf (builtins.length (builtins.attrNames homepage) == 1) + "stylix: ${module}: `meta.homepage.${builtins.head (builtins.attrNames homepage)}` should be simplified to `meta.homepage`" + "**Homepages**: ${renderedHomepages}\n" else - '' - This module is maintained by ${renderedMaintainers}, - pingable via: `${ghHandles}`. - ''; + throw "stylix: ${module}: unexpected type for `meta.homepage`: ${builtins.typeOf homepage}"; + + name = lib.throwIfNot ( + metadata ? ${module}.name + ) "stylix: ${module} is missing `meta.name`" metadata.${module}.name; + in - lib.concatLines [ - mainText - "## Module information" + lib.concatMapStrings (paragraph: "${paragraph}\n\n") [ + "# ${name}" + homepageText maintainersText + "---" + metadata.${module}.description or "" ]; # Module pages initialise all platforms to an empty list, so that diff --git a/docs/src/modules.md b/docs/src/modules.md index 72ebacb0..f3df0983 100644 --- a/docs/src/modules.md +++ b/docs/src/modules.md @@ -157,10 +157,30 @@ directly from `config`. See the reference pages for a list of options. 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. +- `homepage`: homepage string or attribute set of homepage strings, depending + on the number of homepages: + + - ```nix + homepage = "https://github.com/danth/stylix"; + ``` + + - ```nix + homepage = { + Nix = "https://github.com/NixOS/nix"; + Nixpkgs = "https://github.com/NixOS/nixpkgs"; + }; + ``` + + The attribute names are used as hyperlink text and the attribute values are + used as URLs. + +- `maintainers`: required list of maintainers. See [Maintainers](#maintainers) + section. + +- `description`: optional markdown string for extra documentation. + ### Maintainers New modules must have at least one maintainer. diff --git a/modules/alacritty/meta.nix b/modules/alacritty/meta.nix index a6bc39df..84a51cc9 100644 --- a/modules/alacritty/meta.nix +++ b/modules/alacritty/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Alacritty"; + homepage = "https://github.com/alacritty/alacritty"; + maintainers = [ ]; } diff --git a/modules/avizo/meta.nix b/modules/avizo/meta.nix index 155b7ef4..2bd60ec7 100644 --- a/modules/avizo/meta.nix +++ b/modules/avizo/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Avizo"; + homepage = "https://github.com/misterdanb/avizo"; + maintainers = [ ]; } diff --git a/modules/bat/meta.nix b/modules/bat/meta.nix index 3b105ef0..b6be2266 100644 --- a/modules/bat/meta.nix +++ b/modules/bat/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "bat"; + homepage = "https://github.com/sharkdp/bat"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/bemenu/meta.nix b/modules/bemenu/meta.nix index 93c370cc..7a481dcf 100644 --- a/modules/bemenu/meta.nix +++ b/modules/bemenu/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.noodlez1232 ]; name = "bemenu"; + homepage = "https://github.com/Cloudef/bemenu"; + maintainers = [ lib.maintainers.noodlez1232 ]; } diff --git a/modules/bspwm/meta.nix b/modules/bspwm/meta.nix index 2a886834..4baa5562 100644 --- a/modules/bspwm/meta.nix +++ b/modules/bspwm/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "bspwm"; + homepage = "https://github.com/baskerville/bspwm"; + maintainers = [ ]; } diff --git a/modules/btop/meta.nix b/modules/btop/meta.nix index b778eb8c..1420a522 100644 --- a/modules/btop/meta.nix +++ b/modules/btop/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "btop"; + homepage = "https://github.com/aristocratos/btop"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/cava/meta.nix b/modules/cava/meta.nix index 367ea01c..24787588 100644 --- a/modules/cava/meta.nix +++ b/modules/cava/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Cava"; + homepage = "https://github.com/karlstav/cava"; + maintainers = [ ]; } diff --git a/modules/cavalier/meta.nix b/modules/cavalier/meta.nix index 9c9a5090..6b238d09 100644 --- a/modules/cavalier/meta.nix +++ b/modules/cavalier/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Cavalier"; + homepage = "https://github.com/NickvisionApps/Cavalier"; + maintainers = [ ]; } diff --git a/modules/chromium/meta.nix b/modules/chromium/meta.nix index 3409d180..e23b0788 100644 --- a/modules/chromium/meta.nix +++ b/modules/chromium/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.danth ]; name = "Chromium"; + homepage = "https://www.chromium.org/"; + maintainers = [ lib.maintainers.danth ]; } diff --git a/modules/console/meta.nix b/modules/console/meta.nix index 687ee85b..ca14fd69 100644 --- a/modules/console/meta.nix +++ b/modules/console/meta.nix @@ -1,4 +1,4 @@ { - maintainers = [ ]; name = "kernel console"; + maintainers = [ ]; } diff --git a/modules/discord/README.md b/modules/discord/README.md deleted file mode 100644 index f5249219..00000000 --- a/modules/discord/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Discord - -This module provides a collection of targets related to -[Discord](https://discord.com/). The same theme is used regardless of the -method of installation. - -## Vencord, Vesktop - -These targets use the options for [Vencord](https://vencord.dev/) and -[Vesktop](https://github.com/Vencord/Vesktop#readme) which are built in -to Home Manager. - -## Nixcord - -This target leverages the modules provided the -[Nixcord flake](https://github.com/KaylorBen/nixcord). - -> [!IMPORTANT] -> The Nixcord target will have no effect unless Nixcord is properly -> [imported](https://github.com/KaylorBen/nixcord?tab=readme-ov-file#how-to-use-nixcord) -> into your configuration. diff --git a/modules/discord/meta.nix b/modules/discord/meta.nix index e3e0287e..c67eecdd 100644 --- a/modules/discord/meta.nix +++ b/modules/discord/meta.nix @@ -1,5 +1,24 @@ { lib, ... }: { - maintainers = [ lib.maintainers.Flameopathic ]; name = "Discord"; + homepage = { + Discord = "https://discordapp.com/"; + Nixcord = "https://github.com/KaylorBen/nixcord"; + Vencord = "https://github.com/Vendicated/Vencord"; + Vesktop = "https://github.com/Vencord/Vesktop"; + }; + maintainers = [ lib.maintainers.Flameopathic ]; + description = '' + This module provides a collection of targets related to + [Discord](https://discord.com). The same theme is used for each target. + + The Vencord, Vesktop, and Nixcord targets use built-in Home Manager options, + while the Nixcord target leverages + [github:KaylorBen/nixcord](https://github.com/KaylorBen/nixcord). + + > [!IMPORTANT] + > The Nixcord target will have no effect unless Nixcord is properly + > [imported](https://github.com/KaylorBen/nixcord?tab=readme-ov-file#how-to-use-nixcord) + > into your configuration. + ''; } diff --git a/modules/dunst/meta.nix b/modules/dunst/meta.nix index 44cfd0a0..6860d918 100644 --- a/modules/dunst/meta.nix +++ b/modules/dunst/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "Dunst"; + homepage = "https://dunst-project.org/"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/emacs/meta.nix b/modules/emacs/meta.nix index 18d94bd5..a64f7686 100644 --- a/modules/emacs/meta.nix +++ b/modules/emacs/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.panchoh ]; name = "Emacs"; + homepage = "https://www.gnu.org/software/emacs/"; + maintainers = [ lib.maintainers.panchoh ]; } diff --git a/modules/eog/meta.nix b/modules/eog/meta.nix index 69c37fd9..d3b47328 100644 --- a/modules/eog/meta.nix +++ b/modules/eog/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.danth ]; name = "Eye of GNOME"; + homepage = "https://gitlab.gnome.org/GNOME/eog"; + maintainers = [ lib.maintainers.danth ]; } diff --git a/modules/fcitx5/meta.nix b/modules/fcitx5/meta.nix index 11618b77..c43ae716 100644 --- a/modules/fcitx5/meta.nix +++ b/modules/fcitx5/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.make-42 ]; name = "Fcitx 5"; + homepage = "https://fcitx-im.org/wiki/Fcitx_5"; + maintainers = [ lib.maintainers.make-42 ]; } diff --git a/modules/feh/meta.nix b/modules/feh/meta.nix index 29546804..d5fd0a38 100644 --- a/modules/feh/meta.nix +++ b/modules/feh/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "feh"; + homepage = "https://feh.finalrewind.org/"; + maintainers = [ ]; } diff --git a/modules/firefox/README.md b/modules/firefox/README.md deleted file mode 100644 index cb558a47..00000000 --- a/modules/firefox/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Firefox and its derivatives - -This module supports [Firefox](https://www.mozilla.org/firefox/), in addition -to [Floorp](https://floorp.app/) and [LibreWolf](https://librewolf.net/), -which are Firefox derivatives. - -The same implementation is shared between all of these browsers, but they don't -share option values. - -> [!IMPORTANT] -> -> For any theming to be applied, you need to tell this module which -> [profiles](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data) -> you're using: -> -> ```nix -> { -> programs.firefox = { -> enable = true; -> -> profiles = { -> my-profile = { -> # bookmarks, extensions, search engines... -> }; -> my-friends-profile = { -> # bookmarks, extensions, search engines... -> }; -> }; -> }; -> -> stylix.targets.firefox.profileNames = [ "my-profile" "my-friends-profile" ]; -> } -> ``` -> -> This is necessary due to a limitation of the module system: we can either -> detect the list of profiles, or change their configuration, but we can't do -> both without infinite recursion. diff --git a/modules/firefox/meta.nix b/modules/firefox/meta.nix index 0d7bc19f..505794a9 100644 --- a/modules/firefox/meta.nix +++ b/modules/firefox/meta.nix @@ -1,9 +1,50 @@ { lib, ... }: { + name = "Firefox and its derivatives"; + homepage = { + Firefox = "http://www.mozilla.com/en-US/firefox/"; + Floorp = "https://floorp.app/"; + LibreWolf = "https://librewolf.net/"; + }; maintainers = with lib.maintainers; [ Flameopathic danth ]; + description = '' + This module supports [Firefox](https://www.mozilla.org/firefox/), in addition + to [Floorp](https://floorp.app/) and [LibreWolf](https://librewolf.net/), + which are Firefox derivatives. - name = "Firefox and its derivatives"; + The same implementation is shared between all of these browsers, but they don't + share option values. + + > [!IMPORTANT] + > + > For any theming to be applied, you need to tell this module which + > [profiles](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data) + > you're using: + > + > ```nix + > { + > programs.firefox = { + > enable = true; + > + > profiles = { + > my-profile = { + > # bookmarks, extensions, search engines... + > }; + > my-friends-profile = { + > # bookmarks, extensions, search engines... + > }; + > }; + > }; + > + > stylix.targets.firefox.profileNames = [ "my-profile" "my-friends-profile" ]; + > } + > ``` + > + > This is necessary due to a limitation of the module system: we can either + > detect the list of profiles, or change their configuration, but we can't do + > both without infinite recursion. + ''; } diff --git a/modules/fish/meta.nix b/modules/fish/meta.nix index 5d1a6bfd..1e3d3d28 100644 --- a/modules/fish/meta.nix +++ b/modules/fish/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "fish"; + homepage = "https://fishshell.com/"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/fnott/meta.nix b/modules/fnott/meta.nix index f13dfd13..029069f9 100644 --- a/modules/fnott/meta.nix +++ b/modules/fnott/meta.nix @@ -1,8 +1,9 @@ { lib, ... }: { + name = "Fnott"; + homepage = "https://codeberg.org/dnkl/fnott"; maintainers = with lib.maintainers; [ awwpotato MrSom3body ]; - name = "Fnott"; } diff --git a/modules/foot/meta.nix b/modules/foot/meta.nix index c18af727..182cf80f 100644 --- a/modules/foot/meta.nix +++ b/modules/foot/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "foot"; + homepage = "https://codeberg.org/dnkl/foot/"; + maintainers = [ ]; } diff --git a/modules/forge/meta.nix b/modules/forge/meta.nix index 95812409..b1f214bb 100644 --- a/modules/forge/meta.nix +++ b/modules/forge/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Forge"; + homepage = "https://arrayfire.com/"; + maintainers = [ ]; } diff --git a/modules/fuzzel/meta.nix b/modules/fuzzel/meta.nix index e57a56f0..dfa8ddfb 100644 --- a/modules/fuzzel/meta.nix +++ b/modules/fuzzel/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Fuzzel"; + homepage = "https://codeberg.org/dnkl/fuzzel"; + maintainers = [ ]; } diff --git a/modules/fzf/meta.nix b/modules/fzf/meta.nix index 2645e6dd..fb57c58f 100644 --- a/modules/fzf/meta.nix +++ b/modules/fzf/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "fzf"; + homepage = "https://github.com/junegunn/fzf"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/gedit/meta.nix b/modules/gedit/meta.nix index ed26b5cb..321cde8d 100644 --- a/modules/gedit/meta.nix +++ b/modules/gedit/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "gedit"; + homepage = "https://gitlab.gnome.org/World/gedit/gedit"; + maintainers = [ ]; } diff --git a/modules/ghostty/meta.nix b/modules/ghostty/meta.nix index 6b844056..e1d7cd58 100644 --- a/modules/ghostty/meta.nix +++ b/modules/ghostty/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Ghostty"; + homepage = "https://ghostty.org/"; + maintainers = [ ]; } diff --git a/modules/gitui/meta.nix b/modules/gitui/meta.nix index 646c86fb..c7914431 100644 --- a/modules/gitui/meta.nix +++ b/modules/gitui/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "GitUI"; + homepage = "https://github.com/extrawurst/gitui"; + maintainers = [ ]; } diff --git a/modules/glance/meta.nix b/modules/glance/meta.nix index e5fb80db..90003ebd 100644 --- a/modules/glance/meta.nix +++ b/modules/glance/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.louis-thevenet ]; name = "Glance"; + homepage = "https://github.com/glanceapp/glance"; + maintainers = [ lib.maintainers.louis-thevenet ]; } diff --git a/modules/gnome-text-editor/meta.nix b/modules/gnome-text-editor/meta.nix index 98f933c5..eae4f5de 100644 --- a/modules/gnome-text-editor/meta.nix +++ b/modules/gnome-text-editor/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "GNOME Text Editor"; + homepage = "https://gitlab.gnome.org/GNOME/gnome-text-editor"; + maintainers = [ ]; } diff --git a/modules/gnome/meta.nix b/modules/gnome/meta.nix index 0b00bc7a..893d0745 100644 --- a/modules/gnome/meta.nix +++ b/modules/gnome/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.danth ]; name = "GNOME"; + homepage = "https://www.gnome.org/"; + maintainers = [ lib.maintainers.danth ]; } diff --git a/modules/grub/meta.nix b/modules/grub/meta.nix index 3fd716c0..7a54b995 100644 --- a/modules/grub/meta.nix +++ b/modules/grub/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "GRUB"; + homepage = "https://www.gnu.org/software/grub/"; + maintainers = [ ]; } diff --git a/modules/gtk/meta.nix b/modules/gtk/meta.nix index 2e601d24..1064b760 100644 --- a/modules/gtk/meta.nix +++ b/modules/gtk/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.danth ]; name = "GTK"; + homepage = "https://www.gtk.org/"; + maintainers = [ lib.maintainers.danth ]; } diff --git a/modules/halloy/meta.nix b/modules/halloy/meta.nix index c68c43a5..3a361a72 100644 --- a/modules/halloy/meta.nix +++ b/modules/halloy/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Halloy"; + homepage = "https://github.com/squidowl/halloy"; + maintainers = [ ]; } diff --git a/modules/helix/meta.nix b/modules/helix/meta.nix index c6116743..cf4a6668 100644 --- a/modules/helix/meta.nix +++ b/modules/helix/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Helix"; + homepage = "https://helix-editor.com/"; + maintainers = [ ]; } diff --git a/modules/hyprland/meta.nix b/modules/hyprland/meta.nix index 5f81a614..2ebd0b7e 100644 --- a/modules/hyprland/meta.nix +++ b/modules/hyprland/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "Hyprland"; + homepage = "https://github.com/hyprwm/Hyprland"; maintainers = with lib.maintainers; [ naho skoove ]; - - name = "Hyprland"; } diff --git a/modules/hyprlock/meta.nix b/modules/hyprlock/meta.nix index 0cfd337e..60fcd0f5 100644 --- a/modules/hyprlock/meta.nix +++ b/modules/hyprlock/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "hyprlock"; + homepage = "https://github.com/hyprwm/hyprlock"; + maintainers = [ ]; } diff --git a/modules/hyprpaper/meta.nix b/modules/hyprpaper/meta.nix index 71f01553..c3b8d343 100644 --- a/modules/hyprpaper/meta.nix +++ b/modules/hyprpaper/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "hyprpaper"; + homepage = "https://github.com/hyprwm/hyprpaper"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/i3/meta.nix b/modules/i3/meta.nix index a2a929b2..36b17246 100644 --- a/modules/i3/meta.nix +++ b/modules/i3/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "i3"; + homepage = "https://i3wm.org/"; + maintainers = [ ]; } diff --git a/modules/i3status-rust/meta.nix b/modules/i3status-rust/meta.nix index 18576789..ef39174b 100644 --- a/modules/i3status-rust/meta.nix +++ b/modules/i3status-rust/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "i3status-rust"; + homepage = "https://github.com/greshake/i3status-rust"; + maintainers = [ ]; } diff --git a/modules/k9s/meta.nix b/modules/k9s/meta.nix index 4cfaa92a..bb7669f3 100644 --- a/modules/k9s/meta.nix +++ b/modules/k9s/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.cluther ]; name = "K9s"; + homepage = "https://github.com/derailed/k9s"; + maintainers = [ lib.maintainers.cluther ]; } diff --git a/modules/kde/meta.nix b/modules/kde/meta.nix index d3f30f16..6f38def5 100644 --- a/modules/kde/meta.nix +++ b/modules/kde/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "KDE"; + homepage = "https://kde.org/"; + maintainers = [ ]; } diff --git a/modules/kitty/meta.nix b/modules/kitty/meta.nix index 4f187cac..a37d1007 100644 --- a/modules/kitty/meta.nix +++ b/modules/kitty/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "kitty"; + homepage = "https://github.com/kovidgoyal/kitty"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/kmscon/meta.nix b/modules/kmscon/meta.nix index 8df29687..8e12766c 100644 --- a/modules/kmscon/meta.nix +++ b/modules/kmscon/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Kmscon"; + homepage = "https://www.freedesktop.org/wiki/Software/kmscon/"; + maintainers = [ ]; } diff --git a/modules/kubecolor/meta.nix b/modules/kubecolor/meta.nix index fba54f0a..f63aa3a0 100644 --- a/modules/kubecolor/meta.nix +++ b/modules/kubecolor/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.ajgon ]; name = "Kubecolor"; + homepage = "https://github.com/kubecolor/kubecolor"; + maintainers = [ lib.maintainers.ajgon ]; } diff --git a/modules/lazygit/meta.nix b/modules/lazygit/meta.nix index af20bfa5..97c76957 100644 --- a/modules/lazygit/meta.nix +++ b/modules/lazygit/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "Lazygit"; + homepage = "https://github.com/jesseduffield/lazygit"; maintainers = with lib.maintainers; [ mateusauler naho ]; - - name = "Lazygit"; } diff --git a/modules/lightdm/meta.nix b/modules/lightdm/meta.nix index baa5b2c3..d319700f 100644 --- a/modules/lightdm/meta.nix +++ b/modules/lightdm/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "LightDM"; + homepage = "https://github.com/canonical/lightdm"; + maintainers = [ ]; } diff --git a/modules/mako/meta.nix b/modules/mako/meta.nix index 0e3d8d83..7710f23c 100644 --- a/modules/mako/meta.nix +++ b/modules/mako/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.mateusauler ]; name = "mako"; + homepage = "https://wayland.emersion.fr/mako/"; + maintainers = [ lib.maintainers.mateusauler ]; } diff --git a/modules/mangohud/meta.nix b/modules/mangohud/meta.nix index b5d23819..5719a037 100644 --- a/modules/mangohud/meta.nix +++ b/modules/mangohud/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "MangoHud"; + homepage = "https://github.com/flightlessmango/MangoHud"; + maintainers = [ ]; } diff --git a/modules/micro/meta.nix b/modules/micro/meta.nix index 161d3371..c2c8b81e 100644 --- a/modules/micro/meta.nix +++ b/modules/micro/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "micro"; + homepage = "https://micro-editor.github.io/"; + maintainers = [ ]; } diff --git a/modules/mpv/meta.nix b/modules/mpv/meta.nix index d7258bac..287b4158 100644 --- a/modules/mpv/meta.nix +++ b/modules/mpv/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "mpv"; + homepage = "https://mpv.io/"; maintainers = with lib.maintainers; [ awwpotato naho ]; - - name = "mpv"; } diff --git a/modules/ncspot/meta.nix b/modules/ncspot/meta.nix index 11f0ae71..89fdb978 100644 --- a/modules/ncspot/meta.nix +++ b/modules/ncspot/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.awwpotato ]; name = "ncspot"; + homepage = "https://github.com/hrkfdn/ncspot"; + maintainers = [ lib.maintainers.awwpotato ]; } diff --git a/modules/neovim/README.md b/modules/neovim/README.md deleted file mode 100644 index 20aca0a8..00000000 --- a/modules/neovim/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Neovim - -This module themes [Neovim] using the standard Home Manager options. - -## Related modules - - - -- [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]. - -[Neovim]: https://neovim.io -[Nixvim]: https://github.com/nix-community/nixvim#readme -[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/neovim/meta.nix b/modules/neovim/meta.nix index 2ba50962..4d839aea 100644 --- a/modules/neovim/meta.nix +++ b/modules/neovim/meta.nix @@ -1,4 +1,20 @@ { - maintainers = [ ]; name = "Neovim"; + homepage = "https://www.neovim.io/"; + maintainers = [ ]; + description = '' + This module themes [Neovim] using the standard Home Manager options. + + ### Related modules + + + + - [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]. + + [Neovim]: https://neovim.io + [Nixvim]: https://github.com/nix-community/nixvim#readme + [nvf]: https://github.com/NotAShelf/nvf#readme + ''; } diff --git a/modules/nixos-icons/meta.nix b/modules/nixos-icons/meta.nix index af19d510..2657e684 100644 --- a/modules/nixos-icons/meta.nix +++ b/modules/nixos-icons/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "NixOS Icons"; + homepage = "https://github.com/NixOS/nixos-artwork"; + maintainers = [ ]; } diff --git a/modules/nixvim/README.md b/modules/nixvim/README.md deleted file mode 100644 index e1169e6e..00000000 --- a/modules/nixvim/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# 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 - - - -- [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 diff --git a/modules/nixvim/meta.nix b/modules/nixvim/meta.nix index 3ef4c0c9..7dfdfa45 100644 --- a/modules/nixvim/meta.nix +++ b/modules/nixvim/meta.nix @@ -1,5 +1,61 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "NixVim"; + homepage = "https://github.com/nix-community/nixvim"; + maintainers = [ lib.maintainers.naho ]; + description = '' + 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 + + + + - [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 + ''; } diff --git a/modules/nushell/meta.nix b/modules/nushell/meta.nix index e3200b6a..6c885503 100644 --- a/modules/nushell/meta.nix +++ b/modules/nushell/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Nushell"; + homepage = "https://www.nushell.sh/"; + maintainers = [ ]; } diff --git a/modules/nvf/README.md b/modules/nvf/README.md deleted file mode 100644 index 3ad3ad97..00000000 --- a/modules/nvf/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 -> [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. - -## Related modules - - - -- [Vim](vim.md): 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]. - -[Neovim]: https://neovim.io -[Nixvim]: https://github.com/nix-community/nixvim#readme -[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/nvf/meta.nix b/modules/nvf/meta.nix index cce8a6dc..4622378f 100644 --- a/modules/nvf/meta.nix +++ b/modules/nvf/meta.nix @@ -1,5 +1,31 @@ { lib, ... }: { - maintainers = [ lib.maintainers.butzist ]; name = "nvf"; + homepage = "https://github.com/NotAShelf/nvf"; + maintainers = [ lib.maintainers.butzist ]; + description = '' + This module themes [Neovim] using the options provided by [nvf]. + + > [!IMPORTANT] + > 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. + + ### Related modules + + + + - [Vim](vim.md): 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]. + + [Neovim]: https://neovim.io + [Nixvim]: https://github.com/nix-community/nixvim#readme + [nvf]: https://github.com/NotAShelf/nvf#readme + ''; } diff --git a/modules/plymouth/meta.nix b/modules/plymouth/meta.nix index 82bcc672..306f1550 100644 --- a/modules/plymouth/meta.nix +++ b/modules/plymouth/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "Plymouth"; + homepage = "https://www.freedesktop.org/wiki/Software/Plymouth/"; maintainers = with lib.maintainers; [ _0x5a4 danth ]; - - name = "Plymouth"; } diff --git a/modules/qt/meta.nix b/modules/qt/meta.nix index 3a3a600a..158dd5d1 100644 --- a/modules/qt/meta.nix +++ b/modules/qt/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Qt"; + homepage = "https://github.com/KDE/qt"; + maintainers = [ ]; } diff --git a/modules/qutebrowser/meta.nix b/modules/qutebrowser/meta.nix index 838d1ac2..6e4d9015 100644 --- a/modules/qutebrowser/meta.nix +++ b/modules/qutebrowser/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "qutebrowser"; + homepage = "https://github.com/qutebrowser/qutebrowser"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/regreet/meta.nix b/modules/regreet/meta.nix index 851e74dd..405a3664 100644 --- a/modules/regreet/meta.nix +++ b/modules/regreet/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "ReGreet"; + homepage = "https://github.com/rharish101/ReGreet"; + maintainers = [ ]; } diff --git a/modules/rio/meta.nix b/modules/rio/meta.nix index 0b0a9bdc..cc6b7036 100644 --- a/modules/rio/meta.nix +++ b/modules/rio/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Rio"; + homepage = "https://raphamorim.io/rio"; + maintainers = [ ]; } diff --git a/modules/river/meta.nix b/modules/river/meta.nix index cd150b4e..bc690674 100644 --- a/modules/river/meta.nix +++ b/modules/river/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "river"; + homepage = "https://codeberg.org/river/river"; + maintainers = [ ]; } diff --git a/modules/rofi/meta.nix b/modules/rofi/meta.nix index 43f1472f..0f375990 100644 --- a/modules/rofi/meta.nix +++ b/modules/rofi/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Rofi"; + homepage = "https://github.com/davatorium/rofi"; + maintainers = [ ]; } diff --git a/modules/spicetify/README.md b/modules/spicetify/README.md deleted file mode 100644 index c40b3a48..00000000 --- a/modules/spicetify/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# Spicetify - -This Stylix module leverages the modules provided by -[Spicetify-Nix](https://github.com/Gerg-L/spicetify-nix). - -> [!IMPORTANT] -> This module will have no effect unless 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 configuration. -> -> Ensure you are configuring this module on the same platform (NixOS, Home -> Manager, Darwin) as where you installed Spicetify. diff --git a/modules/spicetify/meta.nix b/modules/spicetify/meta.nix index 4d4abfa3..7cb142ec 100644 --- a/modules/spicetify/meta.nix +++ b/modules/spicetify/meta.nix @@ -1,4 +1,19 @@ { - maintainers = [ ]; name = "Spicetify"; + homepage = "https://github.com/Gerg-L/spicetify-nix"; + maintainers = [ ]; + description = '' + This Stylix module leverages the modules provided by + [Spicetify-Nix](https://github.com/Gerg-L/spicetify-nix). + + > [!IMPORTANT] + > This module will have no effect unless 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 configuration. + > + > Ensure you are configuring this module on the same platform (NixOS, Home + > Manager, Darwin) as where you installed Spicetify. + ''; } diff --git a/modules/spotify-player/meta.nix b/modules/spotify-player/meta.nix index 2cb9bca7..fd163304 100644 --- a/modules/spotify-player/meta.nix +++ b/modules/spotify-player/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.repparw ]; name = "spotify-player"; + homepage = "https://github.com/aome510/spotify-player"; + maintainers = [ lib.maintainers.repparw ]; } diff --git a/modules/starship/meta.nix b/modules/starship/meta.nix index 2916a4ed..40ff43c0 100644 --- a/modules/starship/meta.nix +++ b/modules/starship/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.cluther ]; name = "starship"; + homepage = "https://starship.rs/"; + maintainers = [ lib.maintainers.cluther ]; } diff --git a/modules/sway/meta.nix b/modules/sway/meta.nix index 916eaf23..8f9d9d80 100644 --- a/modules/sway/meta.nix +++ b/modules/sway/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Sway"; + homepage = "https://swaywm.org/"; + maintainers = [ ]; } diff --git a/modules/swaylock/meta.nix b/modules/swaylock/meta.nix index db21a179..3cf4a8ed 100644 --- a/modules/swaylock/meta.nix +++ b/modules/swaylock/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "swaylock"; + homepage = "https://github.com/swaywm/swaylock"; + maintainers = [ lib.maintainers.naho ]; } diff --git a/modules/swaync/meta.nix b/modules/swaync/meta.nix index 57e92a8c..75d8714f 100644 --- a/modules/swaync/meta.nix +++ b/modules/swaync/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.themaxmur ]; name = "SwayNotificationCenter"; + homepage = "https://github.com/ErikReider/SwayNotificationCenter"; + maintainers = [ lib.maintainers.themaxmur ]; } diff --git a/modules/sxiv/meta.nix b/modules/sxiv/meta.nix index be63e992..87af12be 100644 --- a/modules/sxiv/meta.nix +++ b/modules/sxiv/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.mateusauler ]; name = "sxiv"; + homepage = "https://github.com/muennich/sxiv"; + maintainers = [ lib.maintainers.mateusauler ]; } diff --git a/modules/tmux/meta.nix b/modules/tmux/meta.nix index 2f2f876c..2a9e9373 100644 --- a/modules/tmux/meta.nix +++ b/modules/tmux/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "tmux"; + homepage = "https://tmux.github.io/"; + maintainers = [ ]; } diff --git a/modules/tofi/meta.nix b/modules/tofi/meta.nix index 34fd87bf..2de9c45f 100644 --- a/modules/tofi/meta.nix +++ b/modules/tofi/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Tofi"; + homepage = "https://github.com/philj56/tofi"; + maintainers = [ ]; } diff --git a/modules/vim/README.md b/modules/vim/README.md deleted file mode 100644 index 159f2fda..00000000 --- a/modules/vim/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Vim - -This module themes [Vim] using the standard Home Manager options. - -## Related modules - - - -- [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]. - -[Vim]: https://www.vim.org -[Nixvim]: https://github.com/nix-community/nixvim#readme -[nvf]: https://github.com/NotAShelf/nvf#readme diff --git a/modules/vim/meta.nix b/modules/vim/meta.nix index 962ff7ac..65bf7cff 100644 --- a/modules/vim/meta.nix +++ b/modules/vim/meta.nix @@ -1,4 +1,20 @@ { - maintainers = [ ]; name = "Vim"; + homepage = "http://www.vim.org/"; + maintainers = [ ]; + description = '' + This module themes [Vim] using the standard Home Manager options. + + ### Related modules + + + + - [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]. + + [Vim]: https://www.vim.org + [Nixvim]: https://github.com/nix-community/nixvim#readme + [nvf]: https://github.com/NotAShelf/nvf#readme + ''; } diff --git a/modules/vscode/meta.nix b/modules/vscode/meta.nix index bcfef079..cb998bd0 100644 --- a/modules/vscode/meta.nix +++ b/modules/vscode/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "VSCode"; + homepage = "https://code.visualstudio.com/"; maintainers = with lib.maintainers; [ Flameopathic danth ]; - - name = "VSCode"; } diff --git a/modules/waybar/meta.nix b/modules/waybar/meta.nix index d60614b0..f41bc311 100644 --- a/modules/waybar/meta.nix +++ b/modules/waybar/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.awwpotato ]; name = "Waybar"; + homepage = "https://github.com/alexays/waybar"; + maintainers = [ lib.maintainers.awwpotato ]; } diff --git a/modules/wayfire/meta.nix b/modules/wayfire/meta.nix index 74a78577..4808fb46 100644 --- a/modules/wayfire/meta.nix +++ b/modules/wayfire/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers._0x5a4 ]; name = "Wayfire"; + homepage = "https://wayfire.org/"; + maintainers = [ lib.maintainers._0x5a4 ]; } diff --git a/modules/wezterm/meta.nix b/modules/wezterm/meta.nix index d0314725..2880eca3 100644 --- a/modules/wezterm/meta.nix +++ b/modules/wezterm/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "WezTerm"; + homepage = "https://wezfurlong.org/wezterm"; + maintainers = [ ]; } diff --git a/modules/wob/meta.nix b/modules/wob/meta.nix index 03850e15..e3572938 100644 --- a/modules/wob/meta.nix +++ b/modules/wob/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "wob"; + homepage = "https://github.com/francma/wob"; + maintainers = [ ]; } diff --git a/modules/wofi/meta.nix b/modules/wofi/meta.nix index 5bad8377..329bb584 100644 --- a/modules/wofi/meta.nix +++ b/modules/wofi/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.mateusauler ]; name = "Wofi"; + homepage = "https://hg.sr.ht/~scoopta/wofi"; + maintainers = [ lib.maintainers.mateusauler ]; } diff --git a/modules/wpaperd/meta.nix b/modules/wpaperd/meta.nix index 60b4ba55..cc6eb13b 100644 --- a/modules/wpaperd/meta.nix +++ b/modules/wpaperd/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "wpaperd"; + homepage = "https://github.com/danyspin97/wpaperd"; + maintainers = [ ]; } diff --git a/modules/xfce/meta.nix b/modules/xfce/meta.nix index 7c797934..fa488b24 100644 --- a/modules/xfce/meta.nix +++ b/modules/xfce/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Xfce"; + homepage = "https://www.xfce.org/"; + maintainers = [ ]; } diff --git a/modules/xresources/meta.nix b/modules/xresources/meta.nix index 4536cc03..1b79a20e 100644 --- a/modules/xresources/meta.nix +++ b/modules/xresources/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Xresources file"; + homepage = "https://www.x.org/wiki/"; + maintainers = [ ]; } diff --git a/modules/yazi/meta.nix b/modules/yazi/meta.nix index 33217dd0..1469b58b 100644 --- a/modules/yazi/meta.nix +++ b/modules/yazi/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Yazi"; + homepage = "https://github.com/sxyazi/yazi"; + maintainers = [ ]; } diff --git a/modules/zathura/meta.nix b/modules/zathura/meta.nix index a80dfbb0..1c4682d0 100644 --- a/modules/zathura/meta.nix +++ b/modules/zathura/meta.nix @@ -1,9 +1,9 @@ { lib, ... }: { + name = "zathura"; + homepage = "https://pwmt.org/projects/zathura/"; maintainers = with lib.maintainers; [ mateusauler naho ]; - - name = "zathura"; } diff --git a/modules/zed/meta.nix b/modules/zed/meta.nix index a1ae523d..01c2beab 100644 --- a/modules/zed/meta.nix +++ b/modules/zed/meta.nix @@ -1,4 +1,5 @@ { - maintainers = [ ]; name = "Zed"; + homepage = "https://zed.brimdata.io/"; + maintainers = [ ]; } diff --git a/modules/zellij/meta.nix b/modules/zellij/meta.nix index 1b03659b..9b9e4979 100644 --- a/modules/zellij/meta.nix +++ b/modules/zellij/meta.nix @@ -1,5 +1,6 @@ { lib, ... }: { - maintainers = [ lib.maintainers.naho ]; name = "Zellij"; + homepage = "https://zellij.dev/"; + maintainers = [ lib.maintainers.naho ]; }