Stylix

https://nix-community.github.io/stylix
Admin
Stylix is a theming framework for NixOS, Home Manager, nix-darwin, and Nix-on-Droid that applies...
Tokens:36,150
Snippets:752
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Zen Browser Configuration Examples

Source: https://nix-community.github.io/stylix/print.html

Examples for configuring Zen Browser theming and profile selection.

```nix
__config.stylix.autoEnable
```

```nix
__false
```

```nix
__true
```

```nix
__[ ]
```

```nix
__[
  "default"
]
```

--------------------------------

### VSCode configuration defaults and examples

Source: https://nix-community.github.io/stylix/options/modules/vscode.html

Default values and example overrides for various VSCode module settings.

```nix
true
```

```nix
false
```

```nix
null
```

```nix
config.stylix.autoEnable
```

```nix
[
  "default"
]
```

--------------------------------

### Build and Preview Documentation

Source: https://nix-community.github.io/stylix/development_environment.html

Build the documentation and start a local web server to preview changes.

```bash
nix run .#doc
```

--------------------------------

### Install Stylix via Standalone Home Manager

Source: https://nix-community.github.io/stylix/installation.html

Minimal flake.nix configuration for using Stylix directly within a Home Manager setup.

```nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    home-manager = {
      url = "github:nix-community/home-manager";
      inputs.nixpkgs.follows = "nixpkgs";
    };
    stylix = {
      url = "github:nix-community/stylix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    {
      nixpkgs,
      home-manager,
      stylix,
      ...
    }:
    {
      homeConfigurations."«username»" = home-manager.lib.homeManagerConfiguration {
        pkgs = nixpkgs.legacyPackages.x86_64-linux;
        modules = [
          stylix.homeModules.stylix
          ./home.nix
        ];
      };
    };
}
```

--------------------------------

### Configure GTK Extra CSS

Source: https://nix-community.github.io/stylix/print.html

Example of adding extra CSS to GTK.

```nix
__""
```

```nix
__''
  // Remove rounded corners
  window.background { border-radius: 0; }
''
```

--------------------------------

### Zen Browser Profile Configuration

Source: https://nix-community.github.io/stylix/print.html

Example configuration for enabling Zen Browser and specifying profile names to avoid infinite recursion.

```nix
__
{
  programs.zen-browser = {
    enable = true;

    profiles = {
      my-profile = {
        # bookmarks, extensions, search engines...
      };
      my-friends-profile = {
        # bookmarks, extensions, search engines...
      };
    };
  };

  stylix.targets.zen-browser.profileNames = [ "my-profile" "my-friends-profile" ];
}
```

--------------------------------

### Run a Stylix Testbed

Source: https://nix-community.github.io/stylix/testbeds.html

Execute this command to start a specific testbed. Replace `«module»` and `«testcase»` with the actual module and test case names.

```bash
user@host:~$ nix run .#testbed:«module»:«testcase»
```

--------------------------------

### Stylix Configuration Defaults and Examples

Source: https://nix-community.github.io/stylix/print.html

Common configuration values used across multiple Stylix modules.

```nix
config.stylix.autoEnable
```

```nix
false
```

```nix
true
```

```nix
null
```

```nix
[ ]
```

--------------------------------

### Customize i3 Bar Configuration

Source: https://nix-community.github.io/stylix/options/modules/i3.html

This example shows how to define a custom i3 bar configuration that can be merged with Stylix's exported bar configuration. Ensure your configuration is placed before the Stylix configuration.

```nix
xsession.windowManager.i3.config.bars = [
  (
    {
      # your configuration
    }
    // config.stylix.targets.i3.exportedBarConfig
  )
];

```

--------------------------------

### Install Stylix on NixOS

Source: https://nix-community.github.io/stylix/installation.html

Minimal flake.nix configuration for integrating Stylix into a NixOS system.

```nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    stylix = {
      url = "github:nix-community/stylix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    { nixpkgs, stylix, ... }:
    {
      nixosConfigurations."«hostname»" = nixpkgs.lib.nixosSystem {
        system = "x86_64-linux";
        modules = [
          stylix.nixosModules.stylix
          ./configuration.nix
        ];
      };
    };
}
```

--------------------------------

### Disable Noctalia theming example

Source: https://nix-community.github.io/stylix/options/modules/noctalia.html

Example configuration to disable theming for Noctalia.

```nix
__false
```

--------------------------------

### Install Stylix on nix-darwin

Source: https://nix-community.github.io/stylix/installation.html

Minimal flake.nix configuration for integrating Stylix into a nix-darwin system.

```nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    darwin = {
      url = "github:nix-darwin/nix-darwin";
      inputs.nixpkgs.follows = "nixpkgs";
    };
    stylix = {
      url = "github:nix-community/stylix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    {
      darwin,
      stylix,
      ...
    }:
    {
      darwinConfigurations."«hostname»" = darwin.lib.darwinSystem {
        system = "aarch64-darwin";
        modules = [
          stylix.darwinModules.stylix
          ./configuration.nix
        ];
      };
    };
}
```

--------------------------------

### Firefox Configuration Boolean Defaults and Examples

Source: https://nix-community.github.io/stylix/options/modules/firefox.html

Common boolean configuration toggles for Firefox and Floorp modules.

```nix
false
```

```nix
true
```

```nix
config.stylix.autoEnable
```

```nix
null
```

```nix
[ ]
```

--------------------------------

### Dynamically Generate Wallpapers with ImageMagick and Themes

Source: https://nix-community.github.io/stylix/tricks.html

Generate wallpapers dynamically based on a selected theme. This example uses ImageMagick to create a solid color wallpaper using a color from a Base16 theme file.

```nix
{ pkgs, lib, ... }:
let
  theme = "${pkgs.base16-schemes}/share/themes/catppuccin-latte.yaml";
  wallpaper = pkgs.runCommand "image.png" { } ''
    COLOR=$(${lib.getExe pkgs.yq} -r .palette.base00 ${theme})
    ${lib.getExe pkgs.imagemagick} -size 1920x1080 xc:$COLOR $out
  '';
in
{
  stylix = {
    image = wallpaper;
    base16Scheme = theme;
  };
}

```

--------------------------------

### Commit Message Examples

Source: https://nix-community.github.io/stylix/commit_convention.html

Illustrative examples of valid Stylix commit messages for various subsystems and changes.

```text
ci: add workflow to label merge conflicts
```

```text
flake: infer default.nix import path
```

```text
fontconfig: align Home Manager with NixOS and enhance docs
```

```text
kde: replace systemd unit with AutostartScript for theme application
```

```text
stylix/droid: fix import droid modules
```

```text
stylix: do not check lambda pattern names with deadnix
```

```text
stylix: rename homeManagerModules to homeModules
```

```text
treewide: adjust notification colors to represent urgency
```

```text
treewide: use mkEnableTargetWith for dynamic autoEnable conditions
```

```text
wayfire: mixup between wayfire and wf-shell settings
```

--------------------------------

### Configure DankCalendar auto-enable setting

Source: https://nix-community.github.io/stylix/options/modules/dank-calendar.html

Sets the default configuration path and example value for enabling DankCalendar theming.

```nix
__config.stylix.autoEnable
```

```nix
__false
```

--------------------------------

### Install Stylix on Nix-on-Droid

Source: https://nix-community.github.io/stylix/installation.html

Minimal flake.nix configuration for integrating Stylix into a Nix-on-Droid environment.

```nix
{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    nix-on-droid = {
      url = "github:nix-community/nix-on-droid";
      inputs.nixpkgs.follows = "nixpkgs";
    };
    stylix = {
      url = "github:nix-community/stylix";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs =
    {
      nix-on-droid,
      nixpkgs,
      stylix,
      ...
    }:
    {
      nixOnDroidConfigurations.default = nix-on-droid.lib.nixOnDroidConfiguration {
        pkgs = nixpkgs.legacyPackages."aarch64-linux";
        modules = [
          stylix.nixOnDroidModules.stylix
          ./nix-on-droid.nix
        ];
      };
    };
}
```

--------------------------------

### Define Color Scheme Attributes

Source: https://nix-community.github.io/stylix/print.html

Example of defining color attributes for a scheme.

```nix
  red = "ff0000";
  # ...
  withHashtag = {
    base08 = "#ff0000";
    # ...
  };
};
```

--------------------------------

### Enable Spicetify Theming (Home Manager)

Source: https://nix-community.github.io/stylix/options/modules/spicetify.html

Set to `false` to disable Spicetify theming. This option respects the global `config.stylix.autoEnable` setting. Ensure Spicetify is installed and configured on the same platform.

```nix
config.stylix.autoEnable
```

```nix
false
```

--------------------------------

### Disable Colors for Avizo

Source: https://nix-community.github.io/stylix/options/modules/avizo.html

Example of setting `config.lib.stylix.colors` to false for Avizo.

```nix
__false
```

--------------------------------

### Match Stylix Release to NixOS Stable

Source: https://nix-community.github.io/stylix/installation.html

Example of pinning Stylix inputs to a specific stable release version.

```nix
{
  nixpkgs.url = "github:NixOS/nixpkgs/nixos-26.05";
  stylix.url = "github:nix-community/stylix/release-26.05";
}
```

--------------------------------

### KDE Executable Package

Source: https://nix-community.github.io/stylix/options/modules/kde.html

Specifies the package containing KDE executables like 'plasma-apply-lookandfeel'. If null, Stylix searches common paths. Example uses '__"pkgs.plasma-workspace"'.

```nix
__"pkgs.plasma-workspace"

```

--------------------------------

### List Available Testbeds

Source: https://nix-community.github.io/stylix/testbeds.html

Run this command from anywhere within the repository to see a list of all available testbeds and their corresponding packages.

```bash
user@host:~$ nix flake show
```

--------------------------------

### List available testbeds

Source: https://nix-community.github.io/stylix/print.html

Run this command to view all available testbed packages defined in the flake.

```bash
user@host:~$ nix flake show
github:nix-community/stylix
└───packages
    └───x86_64-linux
        ├───doc: package 'stylix-book'
        ├───palette-generator: package 'palette-generator'
        ├───"testbed:gnome:cursorless": package 'testbed-gnome-cursorless'
        ├───"testbed:gnome:dark": package 'testbed-gnome-dark'
        ├───"testbed:gnome:imageless": package 'testbed-gnome-imageless'
        ├───"testbed:gnome:light": package 'testbed-gnome-light'
        ├───"testbed:gnome:schemeless": package 'testbed-gnome-schemeless'
        ├───"testbed:kde:cursorless": package 'testbed-kde-cursorless'
        ├───"testbed:kde:dark": package 'testbed-kde-dark'
        ├───"testbed:kde:imageless": package 'testbed-kde-imageless'
        ├───"testbed:kde:light": package 'testbed-kde-light'
        └───"testbed:kde:schemeless": package 'testbed-kde-schemeless'
```

--------------------------------

### Run Stylix Live Demo

Source: https://nix-community.github.io/stylix/print.html

Execute a live demo of the dark theme using the Stylix testbed.

```bash
nix run github:nix-community/stylix#testbed:gnome:dark
```

--------------------------------

### Run Live Demo of Dark Theme

Source: https://nix-community.github.io/stylix/index.html

Use this command to try a live demo of the dark theme. This command fetches and runs the testbed environment for the gnome dark theme.

```bash
nix run github:nix-community/stylix#testbed:gnome:dark
```

--------------------------------

### Set Wallpaper from Local Path

Source: https://nix-community.github.io/stylix/configuration.html

Set the wallpaper by providing a local file path to `stylix.image`.

```nix
{
  stylix.image = ./wallpaper.png;
}
```

--------------------------------

### Execute a specific testbed

Source: https://nix-community.github.io/stylix/print.html

Launch a testbed using the nix run command with the appropriate module and testcase identifiers.

```bash
user@host:~$ nix run .#testbed:«module»:«testcase»
```

--------------------------------

### Using lib.stylix.pixel for Solid Colors

Source: https://nix-community.github.io/stylix/print.html

Simplifies setting a solid color wallpaper based on a specific palette index.

```nix
{ pkgs, config, ... }:
{
  stylix = {
    image = config.lib.stylix.pixel "base0A";
    base16Scheme = "${pkgs.base16-schemes}/share/themes/catppuccin-latte.yaml";
  };
}
```

--------------------------------

### Set Wallpaper

Source: https://nix-community.github.io/stylix/print.html

Configure the desktop wallpaper using a local file path or a remote URL via a derivation.

```nix
{
  stylix.image = ./wallpaper.png;
}
```

```nix
{ pkgs, ... }:
{
  stylix.image = pkgs.fetchurl {
    url = "https://getwallpapers.com/wallpaper/full/1/4/3/523784.jpg";
    hash = "sha256-S/6kgloXiIYI0NblT6YVXfqELApbdHGsuYe6S4JoQwQ=";
  };
}
```

--------------------------------

### Set Wallpaper from URL

Source: https://nix-community.github.io/stylix/configuration.html

Set the wallpaper using a URL by providing a derivation to `stylix.image`. Ensure the URL is valid and the hash is correct.

```nix
{ pkgs, ... }:
{
  stylix.image = pkgs.fetchurl {
    url = "https://getwallpapers.com/wallpaper/full/1/4/3/523784.jpg";
    hash = "sha256-S/6kgloXiIYI0NblT6YVXfqELApbdHGsuYe6S4JoQwQ=";
  };
}
```

--------------------------------

### ReGreet enable theming

Source: https://nix-community.github.io/stylix/print.html

Toggle theming for ReGreet.

```nix
__config.stylix.autoEnable && pkgs.stdenv.hostPlatform.isLinux
```

```nix
__true
```

--------------------------------

### Custom GTK CSS

Source: https://nix-community.github.io/stylix/options/modules/gtk.html

Add extra CSS rules to `gtk-3.0/gtk.css` and `gtk-4.0/gtk.css`. An example shows how to remove rounded corners.

```css
''
  // Remove rounded corners
  window.background { border-radius: 0; }
''
```

--------------------------------

### Configure monitor selection

Source: https://nix-community.github.io/stylix/options/modules/hyprpaper.html

Specifies the monitor to apply the wallpaper to, where an empty string matches all monitors.

```nix
""
```

```nix
"DP-1"
```

--------------------------------

### Enable Blender Theming

Source: https://nix-community.github.io/stylix/options/modules/blender.html

Set to false to disable general theming for Blender. Defaults to config.stylix.autoEnable.

```nix
__false

```

--------------------------------

### Add Extra CSS to ReGreet

Source: https://nix-community.github.io/stylix/options/modules/regreet.html

Provides a way to add extra CSS to ReGreet. Strings are concatenated with newline characters. Example shows how to remove window borders.

```nix
"window.background { border-radius: 0; }"
```

--------------------------------

### KDE Window Decoration Library

Source: https://nix-community.github.io/stylix/print.html

Sets the library for the window decorations theme.

```nix
"org.kde.breeze"
```

--------------------------------

### Generating Configuration Files with Mustache

Source: https://nix-community.github.io/stylix/modules.html

Create a derivation from a Mustache template using the Stylix colors library.

```nix
{ config, ... }:
{
  environment.variables.MY_APPLICATION_CONFIG_FILE =
    let
      configFile = config.lib.stylix.colors {
        template = ./config.toml.mustache;
        extension = ".toml";
      };
    in
    "${configFile}";
}
```

--------------------------------

### Home Manager module usage without flakes

Source: https://nix-community.github.io/stylix/print.html

Importing the Stylix module manually using fetchFromGitHub when flakes are not enabled.

```nix
{ pkgs, ... }:
let
  stylix = pkgs.fetchFromGitHub {
    owner = "nix-community";
    repo = "stylix";
    rev = "...";
    sha256 = "...";
  };
in
{
  imports = [ (import stylix).homeModules.stylix ];

  stylix = {
    enable = true;
    image = ./wallpaper.jpg;
  };
}
```

--------------------------------

### Hyprpaper Monitor Configuration

Source: https://nix-community.github.io/stylix/print.html

Specify the monitor for wallpaper application.

```nix
__""
```

```nix
__"DP-1"
```

--------------------------------

### Configure Xfce theming options

Source: https://nix-community.github.io/stylix/print.html

Settings for enabling Xfce theming and font integration.

```nix
__false
```

```nix
__true
```

```nix
__null
```

--------------------------------

### Generate Wallpaper using lib.stylix.pixel

Source: https://nix-community.github.io/stylix/tricks.html

A concise way to generate a wallpaper using the `lib.stylix.pixel` function, specifying a color from a Base16 theme.

```nix
{ pkgs, config, ... }:
{
  stylix = {
    image = config.lib.stylix.pixel "base0A";
    base16Scheme = "${pkgs.base16-schemes}/share/themes/catppuccin-latte.yaml";
  };
}

```

--------------------------------

### Home Manager Configuration Patterns

Source: https://nix-community.github.io/stylix/print.html

Patterns for applying Stylix options within Home Manager configurations.

```nix
{
  home-manager.sharedModules = [
    {
      stylix.targets.xyz.enable = false;
    }
  ];
}
```

```nix
{
  home-manager.users.«name» = {
    stylix.targets.xyz.enable = false;
  };
}
```

--------------------------------

### Prioritize CSS Styles with lib.mkAfter

Source: https://nix-community.github.io/stylix/tricks.html

Ensure custom CSS styles are applied last by using `lib.mkAfter` for options with the `lines` type, such as Home Manager's `style` options. This prevents conflicting declarations from being overridden unintentionally.

```nix
{ lib, ... }:
{
  programs.waybar = {
    enable = true;
    style = lib.mkAfter ''
      #workspaces button {
        background: @base01;
      }
    '';
  };
}

```

--------------------------------

### Enable GNOME Theming

Source: https://nix-community.github.io/stylix/options/modules/gnome.html

Set to `true` to enable theming for GNOME. This option depends on `config.stylix.autoEnable` and whether the host platform is Linux.

```nix
__config.stylix.autoEnable && pkgs.stdenv.hostPlatform.isLinux
```

```nix
__true
```

--------------------------------

### Import Stylix Module without Flakes

Source: https://nix-community.github.io/stylix/installation.html

Use this approach to import the Stylix module when flakes are not enabled, by fetching the repository via pkgs.fetchFromGitHub.

```nix
{
  imports = [ (import stylix).homeModules.stylix ];

  stylix = {
    enable = true;
    image = ./wallpaper.jpg;
  };
}
```

--------------------------------

### Enable Stylix

Source: https://nix-community.github.io/stylix/configuration.html

To enable Stylix and apply its changes, set `stylix.enable` to `true` in your configuration.

```nix
{
  stylix.enable = true;
}
```

--------------------------------

### KDE Application Style Library

Source: https://nix-community.github.io/stylix/print.html

Sets the library for the application style.

```nix
"default"
```

--------------------------------

### Enter Developer Shell

Source: https://nix-community.github.io/stylix/development_environment.html

Command to enter the project's developer shell environment.

```bash
nix develop
```

--------------------------------

### Manually implement module enabling

Source: https://nix-community.github.io/stylix/modules.html

Replicate mkTarget behavior manually when mkTarget cannot be used by checking both stylix.enable and the target's own enable option.

```nix
{
  config,
  lib,
  ...
}:
{
  options.stylix.targets.«name».enable =
    config.lib.stylix.mkEnableTarget "«human readable name»" true;

  config =
    lib.mkIf (config.stylix.enable && config.stylix.targets.«name».enable)
      {
        programs.«name».backgroundColor = config.lib.stylix.colors.base00;
      };
}
```

--------------------------------

### Set Qt platform theme

Source: https://nix-community.github.io/stylix/options/modules/qt.html

Defines the platform theme for Qt applications.

```nix
__"qtct"
```

--------------------------------

### Zen Browser Profile Names Option

Source: https://nix-community.github.io/stylix/options/modules/zen-browser.html

List of profile names to apply styling to.

```nix
[ ]
```

```nix
[
  "default"
]
```

--------------------------------

### Generating Wallpapers from Themes

Source: https://nix-community.github.io/stylix/print.html

Extracts a color from a Base16 theme file using yq to generate a solid color wallpaper.

```nix
{ pkgs, lib, ... }:
let
  theme = "${pkgs.base16-schemes}/share/themes/catppuccin-latte.yaml";
  wallpaper = pkgs.runCommand "image.png" { } ''
    COLOR=$(${lib.getExe pkgs.yq} -r .palette.base00 ${theme})
    ${lib.getExe pkgs.imagemagick} -size 1920x1080 xc:$COLOR $out
  '';
in
{
  stylix = {
    image = wallpaper;
    base16Scheme = theme;
  };
}
```

--------------------------------

### Configure Qt theming enablement

Source: https://nix-community.github.io/stylix/options/modules/qt.html

Determines if Qt theming is enabled based on system configuration.

```nix
__config.stylix.autoEnable && nixosConfig != null
```

```nix
__true
```

--------------------------------

### Configure enable for Hyprpaper image

Source: https://nix-community.github.io/stylix/options/modules/hyprpaper.html

Sets whether to enable config.stylix.image for hyprpaper.

```nix
true
```

```nix
false
```

--------------------------------

### Set Qt dialogs theme

Source: https://nix-community.github.io/stylix/options/modules/qt.html

Selects the theme for standard Qt dialogs.

```nix
__"default"
```

--------------------------------

### Enable swaylock theming

Source: https://nix-community.github.io/stylix/options/modules/swaylock.html

Toggle automatic theming for swaylock based on system state.

```nix
__config.stylix.autoEnable && lib.versionAtLeast config.home.stateVersion "23.05" && pkgs.stdenv.hostPlatform.isLinux
```

```nix
__true
```

--------------------------------

### Default Desktop Font Size Configuration

Source: https://nix-community.github.io/stylix/options/platforms/nixos.html

Sets the font size for notifications, popups, and other overlay elements. Measured in points.

```nix
__config.stylix.fonts.sizes.desktop
```

--------------------------------

### Configure Home Manager with Flakes

Source: https://nix-community.github.io/stylix/installation.html

Use this flake.nix structure to define dependencies for Home Manager, ensuring version compatibility between Nixpkgs, Home Manager, and Stylix.

```nix
{
  nixpkgs.url = "github:NixOS/nixpkgs/nixos-26.05";
  home-manager.url = "github:nix-community/home-manager/release-26.05";
  stylix.url = "github:nix-community/stylix/release-26.05";
}
```

--------------------------------

### Run Pre-commit Hooks

Source: https://nix-community.github.io/stylix/development_environment.html

Manually execute pre-commit hooks against all files in the repository.

```bash
pre-commit run --all-files
```

--------------------------------

### Configure GNOME Stylix integration

Source: https://nix-community.github.io/stylix/print.html

Options for enabling color, font, and theming integration for GNOME.

```nix
__true
```

```nix
__false
```

```nix
__null
```

```nix
__config.stylix.autoEnable && pkgs.stdenv.hostPlatform.isLinux
```

--------------------------------

### Hyprland Stylix Configuration

Source: https://nix-community.github.io/stylix/print.html

Configuration options for Hyprland compositor integration.

```nix
__true
```

```nix
__false
```

```nix
__null
```

```nix
__config.stylix.autoEnable
```

```nix
__config.stylix.autoEnable && config.stylix.image != null
```

--------------------------------

### Configure Sway wallpaper

Source: https://nix-community.github.io/stylix/print.html

Determines whether to set the wallpaper for Sway based on the image configuration.

```nix
__config.stylix.image != null
```

```nix
__config.stylix.image == null
```

--------------------------------

### Configure Neovim window transparency

Source: https://nix-community.github.io/stylix/options/modules/neovim.html

Sets whether to enable background transparency for the main Neovim window.

```nix
false
```

```nix
true
```

--------------------------------

### Default Application Style

Source: https://nix-community.github.io/stylix/options/modules/kde.html

Sets the default application style for KDE. This is typically '__"default"'.

```nix
__"default"

```

--------------------------------

### Select Neovim colorscheme plugin

Source: https://nix-community.github.io/stylix/options/modules/neovim.html

Specifies the plugin used for the colorscheme.

```nix
"mini.base16"
```

--------------------------------

### Extend NixVim with Stylix configuration

Source: https://nix-community.github.io/stylix/options/modules/neovim.html

Use the exported Stylix module to theme a standalone NixVim configuration.

```nix
{
  inputs,
  config,
  pkgs,
  ...
}:
let
  inherit (pkgs.stdenv.hostPlatform) system;
  nixvim-package = inputs.nixvim-config.packages.${system}.default;
  extended-nixvim = nixvim-package.extend config.stylix.targets.nixvim.exportedModule;
in
{
  environment.systemPackages = [ extended-nixvim ];
}
```

--------------------------------

### Define module description in meta.nix

Source: https://nix-community.github.io/stylix/modules.html

Add a description to modules/«module»/meta.nix to provide general information about the module's functionality and requirements.

```nix
description = ''
  Consider describing which applications are themed by this module (if it's not
  obvious from the module name), how the applications need to be installed for
  the module to work correctly, which theming items are supported (colors,
  fonts, wallpaper, ...), and any caveats the user should be aware of.
'';
```

--------------------------------

### Defining Module Homepage Metadata

Source: https://nix-community.github.io/stylix/modules.html

Specify module homepage URLs as a single string or an attribute set.

```nix
homepage = "https://github.com/nix-community/stylix";
```

```nix
homepage = {
  Nix = "https://github.com/NixOS/nix";
  Nixpkgs = "https://github.com/NixOS/nixpkgs";
};
```

--------------------------------

### KDE Wallpaper Setting

Source: https://nix-community.github.io/stylix/print.html

Controls whether to set the wallpaper for KDE.

```nix
config.stylix.image != null
```

```nix
config.stylix.image == null
```

--------------------------------

### Vesktop Color and Font Configuration

Source: https://nix-community.github.io/stylix/print.html

Options for enabling or overriding color and font settings in Vesktop.

```nix
__true
```

```nix
__false
```

```nix
__null
```

```nix
__config.stylix.autoEnable
```

--------------------------------

### Include Stylix Shared Module for All Users

Source: https://nix-community.github.io/stylix/options/platforms/home_manager.html

This snippet shows how to include the Stylix shared module in your Home Manager configuration to apply settings to all users.

```nix
{
  home-manager.sharedModules = [
    {
      stylix.targets.xyz.enable = false;
    }
  ];
}
```

--------------------------------

### Application Window Opacity

Source: https://nix-community.github.io/stylix/options/platforms/nixos.html

Sets the opacity for application windows. The amount of supported applications is limited.

```nix
__1.0
```
Tokens:
Raw