quirinecker/dotfiles-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

further cleanup and updated readme

Browse Source
This commit is contained in:
quirinecker
2026-08-30 13:44:12 +02:00
parent 47325d4031
commit f185dd9d1b
3 changed files with 6 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -38
View File
@@ -6,23 +6,11 @@ This repository provides a collection of custom NixOS modules which are in use b
To use the modules, add the following flake input to your flake:
```nix
dotfiles-modules = {
url = "github:quirinecker/dotfiles-modules";
inputs.nixpkgs.follows = "nixpkgs";
};
```
In case you want to update the input flakes this flake imports yourself (recommended), then you would need to declare the inputs yourself
and make this flake follow those inputs:
```nix
dotfiles-modules = {
url = "github:quirinecker/dotfiles-modules";
inputs.nixpkgs.follows = "nixpkgs";
inputs.zen-browser.follows = "zen-browser";
inputs.walker.follows = "walker";
inputs.elephant.follows = "elephant";
};
zen-browser = {
@@ -30,44 +18,24 @@ zen-browser = {
inputs.nixpkgs.follows = "nixpkgs";
};
walker = {
url = "github:abenz1267/walker";
inputs.nixpkgs.follows = "nixpkgs";
inputs.elephant.follows = "elephant";
};
elephant = {
url = "github:abenz1267/elephant";
inputs.nixpkgs.follows = "nixpkgs";
};
```
Then import the modules in your home-manager configuration or add it to the modules of the home configuration:
Then import the aspcects in the respective environments:
```nix
imports = [
inputs.dotfiles-modules.homeManager
inputs.dotfiles-modules.modules.homeManager.<aspect>
]
```
or
```nix
homeConfigurations.<username> = home-manager.lib.homeManagerConfiguration {
...
modules = [
inputs.dotfiles-modules.homeManager
];
};
imports = [
inputs.dotfiles-modules.modules.nixos.<aspect>
]
```
**Note:** If you are new to NixOS, i might add a template repository for the modules which should be simmilar to my own homemanager config.
## Modules
The docs for the individual mdoules can be found [here](options.md).
For more information on which aspects are available, see `./modules/*`
## Development
docs.nix
-46
View File
@@ -1,46 +0,0 @@
{
buildDocs =
{
pkgs,
inputs,
modules,
}:
let
eval = pkgs.lib.evalModules {
specialArgs = {
inherit inputs pkgs;
};
modules = [
(
{ ... }:
{
imports = modules;
_module.check = false;
}
)
];
};
replaceNixPathWithRelative =
p:
let
match = builtins.match "^/nix/store/[^/]+/(.*)$" p;
in
if match != null then
"https://gitlab.com/quirinecker/dotfiles-modules/" + builtins.elemAt match 0
else
p;
transformOptions =
o:
let
declarations = o.declarations;
mappedDeclarations = builtins.map (d: replaceNixPathWithRelative d) declarations;
in
o // { declarations = mappedDeclarations; };
in
pkgs.nixosOptionsDoc {
options = eval.options;
transformOptions = o: transformOptions o;
};
}
options.md
-171
View File
@@ -1,171 +0,0 @@
# NixOS Module Options
## [`options.modules.walker.enable`](homemanager/walker.nix#L9)
walker
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.fish.enable`](homemanager/fish.nix#L12)
fish
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.hyprpanel.enable`](homemanager/hyprpanel.nix#L8)
hyprpanel
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.hyprpanel.avatar.image`](homemanager/hyprpanel.nix#L9)
avatar image
**Type:** `lib.types.path`
**Default:** `""`
## [`options.modules.hyprpanel.avatar.name`](homemanager/hyprpanel.nix#L15)
Username to be displayed
**Type:** `lib.types.str`
**Default:** `"John Doe"`
## [`options.modules.theme.enable`](homemanager/theme.nix#L9)
theme
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.default_apps.enable`](homemanager/default_apps.nix#L11)
default_apps
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.editorconfig.enable`](homemanager/editorconfig.nix#L4)
enables editorconfig
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.utilities.enable`](homemanager/utilities.nix#L9)
utilities
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.terminalEmulators.kitty.enable`](homemanager/terminal_emulators/kitty.nix#L4)
kitty
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.terminalEmulators.ghostty.enable`](homemanager/terminal_emulators/ghostty.nix#L12)
ghostty
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.terminalEmulators.wezterm.enable`](homemanager/terminal_emulators/wezterm.nix#L7)
kitty
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.nushell.enable`](homemanager/nushell.nix#L8)
nushell
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.neovim.enable`](homemanager/neovim.nix#L22)
neovim
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.hyprland.enable`](homemanager/hyprland.nix#L12)
hyprland
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.tmux.enable`](homemanager/tmux.nix#L12)
tmux
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
## [`options.modules.starship.enable`](homemanager/starship.nix#L16)
enables starship
**Type:** `boolean`
**Default:** `false`
**Example:** `true`
---
*Generated with [nix-options-doc](https://github.com/Thunderbottom/nix-options-doc)*