Mirrors/stylix
2
0
Fork 0
mirror of https://github.com/danth/stylix synced 2024-11-25 13:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

treewide: remove lib.mdDoc (#349)

Browse source
This commit is contained in:
Daniel Thwaites 2024-04-22 22:25:40 +01:00 committed by GitHub
parent 267cf91e03
commit 0fe277a364
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 40 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
modules/bemenu/hm.nix
View file

@ -9,7 +9,7 @@ in {
enable = config.lib.stylix.mkEnableTarget "bemenu" true;
fontSize = lib.mkOption {
description = lib.mdDoc ''
description = ''
Font size used for bemenu.
'';
type = with lib.types; nullOr int;
@ -17,7 +17,7 @@ in {
}; # optional argument
alternate = lib.mkOption {
description = lib.mdDoc ''
description = ''
Whether to use alternating colours.
'';
type = lib.types.bool;

2
modules/gnome/nixos.nix
View file

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

2
modules/grub/nixos.nix
View file

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

2
modules/gtk/hm.nix
View file

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

2
modules/kitty/hm.nix
View file

@ -11,7 +11,7 @@ in {
enable = config.lib.stylix.mkEnableTarget "Kitty" true;
variant256Colors = lib.mkOption {
description = lib.mdDoc ''
description = ''
Whether to use the [256-color variant](https://github.com/kdrag0n/base16-kitty#256-color-variants)
rather than the default combination of colors.
'';

4
modules/plymouth/nixos.nix
View file

@ -46,7 +46,7 @@ in {
enable = config.lib.stylix.mkEnableTarget "the Plymouth boot screen" true;
logo = mkOption {
description = mdDoc "Logo to be used on the boot screen.";
description = "Logo to be used on the boot screen.";
type = with types; either path package;
defaultText = literalMD "NixOS logo";
@ -60,7 +60,7 @@ in {
};
logoAnimated = mkOption {
description = mdDoc ''
description = ''
Whether to apply a spinning animation to the logo.
Disabling this allows the use of logos which don't have rotational

2
modules/swaylock/hm.nix
View file

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

6
modules/waybar/hm.nix
View file

@ -18,17 +18,17 @@ in
enableLeftBackColors = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc "enables background colors on the left side of the bar";
description = "enables background colors on the left side of the bar";
};
enableCenterBackColors = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc "enables background colors on the center of the bar";
description = "enables background colors on the center of the bar";
};
enableRightBackColors = lib.mkOption {
type = lib.types.bool;
default = false;
description = lib.mdDoc "enables background colors on the right side of the bar";
description = "enables background colors on the right side of the bar";
};
};

6
stylix/cursor.nix
View file

@ -8,17 +8,17 @@ let
in {
options.stylix.cursor = {
name = mkOption {
description = mdDoc "The cursor name within the package.";
description = "The cursor name within the package.";
type = types.str;
default = fromOs [ "cursor" "name" ] "Vanilla-DMZ";
};
package = mkOption {
description = mdDoc "Package providing the cursor theme.";
description = "Package providing the cursor theme.";
type = types.package;
default = fromOs [ "cursor" "package" ] pkgs.vanilla-dmz;
};
size = mkOption {
description = mdDoc "The cursor size.";
description = "The cursor size.";
type = types.int;
default = fromOs [ "cursor" "size" ] 32;
};

4
stylix/darwin/default.nix
View file

@ -16,7 +16,7 @@ in {
options.stylix.homeManagerIntegration = {
followSystem = lib.mkOption {
description = lib.mdDoc ''
description = ''
When this option is `true`, Home Manager will follow
the system theme by default, rather than requiring a theme to be set.
@ -28,7 +28,7 @@ in {
};
autoImport = lib.mkOption {
description = lib.mdDoc ''
description = ''
Whether to enable Stylix automatically for every user.
This only applies to users for which Home Manager is set up within the

22
stylix/fonts.nix
View file

@ -10,12 +10,12 @@ let
fontType = types.submodule {
options = {
package = mkOption {
description = mdDoc "Package providing the font.";
description = "Package providing the font.";
type = types.package;
};
name = mkOption {
description = mdDoc "Name of the font within the package.";
description = "Name of the font within the package.";
type = types.str;
};
};
@ -24,7 +24,7 @@ let
in {
options.stylix.fonts = {
serif = mkOption {
description = mdDoc "Serif font.";
description = "Serif font.";
type = fontType;
default = fromOs [ "fonts" "serif" ] {
package = pkgs.dejavu_fonts;
@ -33,7 +33,7 @@ in {
};
sansSerif = mkOption {
description = mdDoc "Sans-serif font.";
description = "Sans-serif font.";
type = fontType;
default = fromOs [ "fonts" "sansSerif" ] {
package = pkgs.dejavu_fonts;
@ -42,7 +42,7 @@ in {
};
monospace = mkOption {
description = mdDoc "Monospace font.";
description = "Monospace font.";
type = fontType;
default = fromOs [ "fonts" "monospace" ] {
package = pkgs.dejavu_fonts;
@ -51,7 +51,7 @@ in {
};
emoji = mkOption {
description = mdDoc "Emoji font.";
description = "Emoji font.";
type = fontType;
default = fromOs [ "fonts" "emoji" ] {
package = pkgs.noto-fonts-emoji;
@ -61,7 +61,7 @@ in {
sizes = {
desktop = mkOption {
description = mdDoc ''
description = ''
The font size used in window titles/bars/widgets elements of
the desktop.
'';
@ -70,7 +70,7 @@ in {
};
applications = mkOption {
description = mdDoc ''
description = ''
The font size used by applications.
'';
type = types.ints.unsigned;
@ -78,7 +78,7 @@ in {
};
terminal = mkOption {
description = mdDoc ''
description = ''
The font size for terminals/text editors.
'';
type = types.ints.unsigned;
@ -86,7 +86,7 @@ in {
};
popups = mkOption {
description = mdDoc ''
description = ''
The font size for notifications/popups and in general overlay
elements of the desktop.
'';
@ -96,7 +96,7 @@ in {
};
packages = mkOption {
description = mdDoc ''
description = ''
A list of all the font packages that will be installed.
'';
type = types.listOf types.package;

4
stylix/nixos/default.nix
View file

@ -18,7 +18,7 @@ in {
options.stylix.homeManagerIntegration = {
followSystem = lib.mkOption {
description = lib.mdDoc ''
description = ''
When this option is `true`, Home Manager will follow
the system theme by default, rather than requiring a theme to be set.
@ -30,7 +30,7 @@ in {
};
autoImport = lib.mkOption {
description = lib.mdDoc ''
description = ''
Whether to enable Stylix automatically for every user.
This only applies to users for which Home Manager is set up within the

8
stylix/opacity.nix
View file

@ -8,22 +8,22 @@ let
in {
options.stylix.opacity = {
desktop = mkOption {
description = mdDoc "The opacity of the windows of bars/widgets, the amount of applications supported is currently limited";
description = "The opacity of the windows of bars/widgets, the amount of applications supported is currently limited";
type = types.float;
default = fromOs [ "opacity" "desktop" ] 1.0;
};
applications = mkOption {
description = mdDoc "The opacity of the windows of applications, the amount of applications supported is currently limited";
description = "The opacity of the windows of applications, the amount of applications supported is currently limited";
type = types.float;
default = fromOs [ "opacity" "applications" ] 1.0;
};
terminal = mkOption {
description = mdDoc "The opacity of the windows of terminals, this works across all terminals supported by stylix";
description = "The opacity of the windows of terminals, this works across all terminals supported by stylix";
type = types.float;
default = fromOs [ "opacity" "terminal" ] 1.0;
};
popups = mkOption {
description = mdDoc "The opacity of the windows of notifications/popups, the amount of applications supported is currently limited";
description = "The opacity of the windows of notifications/popups, the amount of applications supported is currently limited";
type = types.float;
default = fromOs [ "opacity" "popups" ] 1.0;
};

8
stylix/palette.nix
View file

@ -55,7 +55,7 @@ in {
polarity = mkOption {
type = types.enum [ "either" "light" "dark" ];
default = fromOs [ "polarity" ] "either";
description = mdDoc ''
description = ''
Use this option to force a light or dark theme.
By default we will select whichever is ranked better by the genetic
@ -66,7 +66,7 @@ in {
image = mkOption {
type = types.coercedTo types.package toString types.path;
description = mdDoc ''
description = ''
Wallpaper image.
This is set as the background of your desktop environment, if possible,
@ -101,7 +101,7 @@ in {
};
base16Scheme = mkOption {
description = mdDoc ''
description = ''
A scheme following the base16 standard.
This can be a path to a file, a string of YAML, or an attribute set.
@ -120,7 +120,7 @@ in {
};
override = mkOption {
description = mdDoc ''
description = ''
An override that will be applied to stylix.base16Scheme when generating
lib.stylix.colors.

4
stylix/target.nix
View file

@ -6,7 +6,7 @@ let
fromOs = import ./fromos.nix { inherit lib args; };
in {
options.stylix.autoEnable = mkOption {
description = mdDoc "Whether to automatically enable styling for installed targets.";
description = "Whether to automatically enable styling for installed targets.";
type = types.bool;
default = fromOs [ "autoEnable" ] true;
};
@ -25,7 +25,7 @@ in {
autoEnable:
mkOption {
description = mdDoc "Whether to style ${humanName}.";
description = "Whether to style ${humanName}.";
type = types.bool;
# We can't substitute the target name into this description because some