Convert documentation to mdBook 📝 🔨

modules/bemenu/hm.nix

@@ -5,11 +5,22 @@ with config.stylix.fonts;
 {
   options.stylix.targets.bemenu = {
     enable = config.lib.stylix.mkEnableTarget "bemenu" true;
+
     fontSize = lib.mkOption {
+      description = lib.mdDoc ''
+        Font size used for bemenu.
+      '';
       type = with lib.types; nullOr int;
       default = sizes.popups;
     }; # optional argument
-    alternate = lib.mkOption { type = lib.types.bool; default = false; };
+
+    alternate = lib.mkOption {
+      description = lib.mdDoc ''
+        Whether to use alternating colours.
+      '';
+      type = lib.types.bool;
+      default = false;
+    };
   };
 
   config = lib.mkIf config.stylix.targets.bemenu.enable {
@@ -27,10 +38,8 @@ with config.stylix.fonts;
       "--nf '${base05}'"
       "--scb '${base01}'"
       "--scf '${base03}'"
-      # Alternating colours, currently set to match primary. Adding a module option to enable or disable alternating in Stylix could be useful
       "--ab '${if alternate then base00 else base01}'"
       "--af '${if alternate then base04 else base05}'"
-
       "--fn '${sansSerif.name} ${lib.optionalString (fontSize != null) (builtins.toString fontSize)}'" 
     ];
   };

modules/gnome/nixos.nix

@@ -7,7 +7,7 @@ let
 in {
   options.stylix.targets.gnome.enable =
     lib.mkOption {
-      description = "Whether to style GNOME";
+      description = lib.mdDoc "Whether to style GNOME";
       type = lib.types.bool;
       default = config.stylix.autoEnable 
              && config.services.xserver.desktopManager.gnome.enable;

modules/grub/nixos.nix

@@ -27,7 +27,7 @@ in {
     enable = config.lib.stylix.mkEnableTarget "GRUB" true;
 
     useImage = lib.mkOption {
-      description = "Whether to use your wallpaper image as the GRUB background.";
+      description = lib.mdDoc "Whether to use your wallpaper image as the GRUB background.";
       type = lib.types.bool;
       default = false;
     };

modules/gtk/hm.nix

@@ -21,9 +21,8 @@ in {
       "all GTK3, GTK4 and Libadwaita apps" true;
 
     extraCss = mkOption {
-      description = ''
-        Extra code added to <literal>gtk-3.0/gtk.css</literal>
-        and <literal>gtk-4.0/gtk.css</literal>.
+      description = mdDoc ''
+        Extra code added to `gtk-3.0/gtk.css` and `gtk-4.0/gtk.css`.
       '';
       type = types.lines;
       default = "";

modules/kitty/hm.nix

@@ -14,7 +14,15 @@ let
 in {
   options.stylix.targets.kitty = {
     enable = config.lib.stylix.mkEnableTarget "Kitty" true;
-    variant256Colors = lib.mkOption { type = lib.types.bool; default = false; };
+
+    variant256Colors = lib.mkOption {
+      description = lib.mdDoc ''
+        Whether to use the [256-color variant](https://github.com/kdrag0n/base16-kitty#256-color-variants)
+        rather than the default combination of colors.
+      '';
+      type = lib.types.bool;
+      default = false;
+    };
   };
 
   config = lib.mkIf cfg.enable {

modules/plymouth/nixos.nix

@@ -48,14 +48,14 @@ in {
     enable = config.lib.stylix.mkEnableTarget "the Plymouth boot screen" true;
 
     logo = mkOption {
-      description = ''
+      description = mdDoc ''
         Logo to be used on the boot screen.
 
         This defaults to the NixOS logo, but you could set it to your OEM logo
         if it suits the theme.
       '';
       type = with types; either path package;
-      defaultText = literalDocBook "NixOS snowflake";
+      defaultText = literalMD "NixOS snowflake";
       default = pkgs.fetchurl {
         url = "https://raw.githubusercontent.com/NixOS/nixos-artwork/master/logo/nix-snowflake.svg";
         # Reduce size
@@ -69,14 +69,14 @@ in {
     };
 
     blackBackground = mkOption {
-      description = ''
+      description = mdDoc ''
         Whether to use a black background rather than a theme colour.
 
         This looks good in combination with systemd-boot, as it means that the
         background colour doesn't change throughout the boot process.
       '';
       type = types.bool;
-      defaultText = literalDocBook "<literal>true</literal> if systemd-boot is enabled";
+      defaultText = literalMD "`true` if systemd-boot is enabled";
       default = config.boot.loader.systemd-boot.enable;
     };
   };

modules/swaylock/hm.nix

@@ -14,7 +14,7 @@ in {
   options.stylix.targets.swaylock = {
     enable = config.lib.stylix.mkEnableTarget "Swaylock" true;
     useImage = lib.mkOption {
-      description = ''
+      description = lib.mdDoc ''
         Whether to use your wallpaper image for the Swaylock background.
         If this is disabled, a plain color will be used instead.
       '';