Add comprehensive inline documentation to all modules and enhance README

Co-authored-by: dwinkler1 <22460147+dwinkler1@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2026-01-11 19:40:13 +00:00
commit 40095ac868
13 changed files with 587 additions and 32 deletions

View file

@ -1,12 +1,30 @@
# Extra theme packages overlay
#
# This overlay configures the Neovim color scheme based on user configuration.
# It transforms the theme config from flake.nix into a Neovim plugin structure.
#
# Usage:
# - Configure theme in flake.nix config.theme section
# - Specify colorscheme name, background (dark/light)
# - Add custom Lua configuration in extraColorschemePackage
#
# The overlay exports:
# - extraTheme: Plugin structure with theme configuration
#
# Built-in themes: cyberdream, onedark, tokyonight, kanagawa
config: final: prev: let
# Transform user theme config into Neovim plugin format
extraTheme = {
# Get the plugin package from nixpkgs
plugin = prev.vimPlugins."${config.theme.extraColorschemePackage.plugin}";
# Theme name for identification
name = config.theme.extraColorschemePackage.name;
# Lua configuration to run when theme loads
config = {
lua = config.theme.extraColorschemePackage.extraLua;
};
};
in {
# Export theme for use in Neovim configuration
inherit extraTheme;
}