doc: restructure module rendering (#1083)

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

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.

modules/alacritty/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Alacritty";
+  homepage = "https://github.com/alacritty/alacritty";
+  maintainers = [ ];
 }

modules/avizo/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Avizo";
+  homepage = "https://github.com/misterdanb/avizo";
+  maintainers = [ ];
 }

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 ];
 }

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 ];
 }

modules/bspwm/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "bspwm";
+  homepage = "https://github.com/baskerville/bspwm";
+  maintainers = [ ];
 }

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 ];
 }

modules/cava/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Cava";
+  homepage = "https://github.com/karlstav/cava";
+  maintainers = [ ];
 }

modules/cavalier/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Cavalier";
+  homepage = "https://github.com/NickvisionApps/Cavalier";
+  maintainers = [ ];
 }

modules/chromium/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.danth ];
   name = "Chromium";
+  homepage = "https://www.chromium.org/";
+  maintainers = [ lib.maintainers.danth ];
 }

modules/console/meta.nix

@@ -1,4 +1,4 @@
 {
-  maintainers = [ ];
   name = "kernel console";
+  maintainers = [ ];
 }

modules/discord/README.md

@@ -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.

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.
+  '';
 }

modules/dunst/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.naho ];
   name = "Dunst";
+  homepage = "https://dunst-project.org/";
+  maintainers = [ lib.maintainers.naho ];
 }

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 ];
 }

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 ];
 }

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 ];
 }

modules/feh/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "feh";
+  homepage = "https://feh.finalrewind.org/";
+  maintainers = [ ];
 }

modules/firefox/README.md

@@ -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.

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.
+  '';
 }

modules/fish/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.naho ];
   name = "fish";
+  homepage = "https://fishshell.com/";
+  maintainers = [ lib.maintainers.naho ];
 }

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";
 }

modules/foot/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "foot";
+  homepage = "https://codeberg.org/dnkl/foot/";
+  maintainers = [ ];
 }

modules/forge/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Forge";
+  homepage = "https://arrayfire.com/";
+  maintainers = [ ];
 }

modules/fuzzel/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Fuzzel";
+  homepage = "https://codeberg.org/dnkl/fuzzel";
+  maintainers = [ ];
 }

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 ];
 }

modules/gedit/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "gedit";
+  homepage = "https://gitlab.gnome.org/World/gedit/gedit";
+  maintainers = [ ];
 }

modules/ghostty/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Ghostty";
+  homepage = "https://ghostty.org/";
+  maintainers = [ ];
 }

modules/gitui/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "GitUI";
+  homepage = "https://github.com/extrawurst/gitui";
+  maintainers = [ ];
 }

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 ];
 }

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 = [ ];
 }

modules/gnome/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.danth ];
   name = "GNOME";
+  homepage = "https://www.gnome.org/";
+  maintainers = [ lib.maintainers.danth ];
 }

modules/grub/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "GRUB";
+  homepage = "https://www.gnu.org/software/grub/";
+  maintainers = [ ];
 }

modules/gtk/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.danth ];
   name = "GTK";
+  homepage = "https://www.gtk.org/";
+  maintainers = [ lib.maintainers.danth ];
 }

modules/halloy/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Halloy";
+  homepage = "https://github.com/squidowl/halloy";
+  maintainers = [ ];
 }

modules/helix/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Helix";
+  homepage = "https://helix-editor.com/";
+  maintainers = [ ];
 }

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";
 }

modules/hyprlock/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "hyprlock";
+  homepage = "https://github.com/hyprwm/hyprlock";
+  maintainers = [ ];
 }

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 ];
 }

modules/i3/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "i3";
+  homepage = "https://i3wm.org/";
+  maintainers = [ ];
 }

modules/i3status-rust/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "i3status-rust";
+  homepage = "https://github.com/greshake/i3status-rust";
+  maintainers = [ ];
 }

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 ];
 }

modules/kde/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "KDE";
+  homepage = "https://kde.org/";
+  maintainers = [ ];
 }

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 ];
 }

modules/kmscon/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Kmscon";
+  homepage = "https://www.freedesktop.org/wiki/Software/kmscon/";
+  maintainers = [ ];
 }

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 ];
 }

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";
 }

modules/lightdm/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "LightDM";
+  homepage = "https://github.com/canonical/lightdm";
+  maintainers = [ ];
 }

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 ];
 }

modules/mangohud/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "MangoHud";
+  homepage = "https://github.com/flightlessmango/MangoHud";
+  maintainers = [ ];
 }

modules/micro/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "micro";
+  homepage = "https://micro-editor.github.io/";
+  maintainers = [ ];
 }

modules/mpv/meta.nix

@@ -1,9 +1,9 @@
 { lib, ... }:
 {
+  name = "mpv";
+  homepage = "https://mpv.io/";
   maintainers = with lib.maintainers; [
     awwpotato
     naho
   ];
-
-  name = "mpv";
 }

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 ];
 }

modules/neovim/README.md

@@ -1,15 +0,0 @@
-# Neovim
-
-This module themes [Neovim] using the standard Home Manager options.
-
-## 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.
-- [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

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
+
+    <!-- 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.
+    - [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
+  '';
 }

modules/nixos-icons/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "NixOS Icons";
+  homepage = "https://github.com/NixOS/nixos-artwork";
+  maintainers = [ ];
 }

modules/nixvim/README.md

@@ -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
-
-<!-- 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

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
+
+    <!-- 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
+  '';
 }

modules/nushell/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Nushell";
+  homepage = "https://www.nushell.sh/";
+  maintainers = [ ];
 }

modules/nvf/README.md

@@ -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
-
-<!-- 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.
-- [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

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
+
+    <!-- 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.
+    - [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
+  '';
 }

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";
 }

modules/qt/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Qt";
+  homepage = "https://github.com/KDE/qt";
+  maintainers = [ ];
 }

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 ];
 }

modules/regreet/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "ReGreet";
+  homepage = "https://github.com/rharish101/ReGreet";
+  maintainers = [ ];
 }

modules/rio/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Rio";
+  homepage = "https://raphamorim.io/rio";
+  maintainers = [ ];
 }

modules/river/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "river";
+  homepage = "https://codeberg.org/river/river";
+  maintainers = [ ];
 }

modules/rofi/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Rofi";
+  homepage = "https://github.com/davatorium/rofi";
+  maintainers = [ ];
 }

modules/spicetify/README.md

@@ -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.

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.
+  '';
 }

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 ];
 }

modules/starship/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.cluther ];
   name = "starship";
+  homepage = "https://starship.rs/";
+  maintainers = [ lib.maintainers.cluther ];
 }

modules/sway/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Sway";
+  homepage = "https://swaywm.org/";
+  maintainers = [ ];
 }

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 ];
 }

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 ];
 }

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 ];
 }

modules/tmux/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "tmux";
+  homepage = "https://tmux.github.io/";
+  maintainers = [ ];
 }

modules/tofi/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Tofi";
+  homepage = "https://github.com/philj56/tofi";
+  maintainers = [ ];
 }

modules/vim/README.md

@@ -1,15 +0,0 @@
-# Vim
-
-This module themes [Vim] using the standard Home Manager options.
-
-## Related modules
-
-<!-- If updating this section, make sure to update it on the linked pages too. -->
-
-- [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

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
+
+    <!-- If updating this section, make sure to update it on the linked pages too. -->
+
+    - [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
+  '';
 }

modules/vscode/meta.nix

@@ -1,9 +1,9 @@
 { lib, ... }:
 {
+  name = "VSCode";
+  homepage = "https://code.visualstudio.com/";
   maintainers = with lib.maintainers; [
     Flameopathic
     danth
   ];
-
-  name = "VSCode";
 }

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 ];
 }

modules/wayfire/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers._0x5a4 ];
   name = "Wayfire";
+  homepage = "https://wayfire.org/";
+  maintainers = [ lib.maintainers._0x5a4 ];
 }

modules/wezterm/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "WezTerm";
+  homepage = "https://wezfurlong.org/wezterm";
+  maintainers = [ ];
 }

modules/wob/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "wob";
+  homepage = "https://github.com/francma/wob";
+  maintainers = [ ];
 }

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 ];
 }

modules/wpaperd/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "wpaperd";
+  homepage = "https://github.com/danyspin97/wpaperd";
+  maintainers = [ ];
 }

modules/xfce/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Xfce";
+  homepage = "https://www.xfce.org/";
+  maintainers = [ ];
 }

modules/xresources/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Xresources file";
+  homepage = "https://www.x.org/wiki/";
+  maintainers = [ ];
 }

modules/yazi/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Yazi";
+  homepage = "https://github.com/sxyazi/yazi";
+  maintainers = [ ];
 }

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";
 }

modules/zed/meta.nix

@@ -1,4 +1,5 @@
 {
-  maintainers = [ ];
   name = "Zed";
+  homepage = "https://zed.brimdata.io/";
+  maintainers = [ ];
 }

modules/zellij/meta.nix

@@ -1,5 +1,6 @@
 { lib, ... }:
 {
-  maintainers = [ lib.maintainers.naho ];
   name = "Zellij";
+  homepage = "https://zellij.dev/";
+  maintainers = [ lib.maintainers.naho ];
 }