docs: fmt with prettier

This commit is contained in:
notohh 2024-02-01 17:31:35 -05:00
parent 74c6055414
commit 3a3965b4d9
Signed by: notohh
GPG key ID: BD47506D475EE86D
6 changed files with 81 additions and 79 deletions

View file

@ -25,8 +25,8 @@
## :open_book: Table of contents ## :open_book: Table of contents
+ :house_with_garden: [home](src/branch/master/home) - :house_with_garden: [home](src/branch/master/home)
+ :computer: [hosts](src/branch/master/hosts) - :computer: [hosts](src/branch/master/hosts)
- :cloud_with_rain: [ame](src/branch/master/hosts/ame) - :cloud_with_rain: [ame](src/branch/master/hosts/ame)
- :cloud_with_lightning_and_rain: [arashi](src/branch/master/hosts/arashi) - :cloud_with_lightning_and_rain: [arashi](src/branch/master/hosts/arashi)
- :hibiscus: [haru](src/branch/master/hosts/haru) - :hibiscus: [haru](src/branch/master/hosts/haru)
@ -37,29 +37,31 @@
- :full_moon: [tsuki](src/branch/master/hosts/tsuki) - :full_moon: [tsuki](src/branch/master/hosts/tsuki)
- :building_construction: [tsuru](src/branch/master/hosts/tsuru) - :building_construction: [tsuru](src/branch/master/hosts/tsuru)
- :snowflake: [yuki](src/branch/master/hosts/yuki) - :snowflake: [yuki](src/branch/master/hosts/yuki)
+ :electric_plug: [modules](src/branch/master/modules) - :electric_plug: [modules](src/branch/master/modules)
+ :package: [pkgs](src/branch/master/pkgs) - :package: [pkgs](src/branch/master/pkgs)
+ :lock: [secrets](src/branch/master/secrets) - :lock: [secrets](src/branch/master/secrets)
## :spiral_notepad: Features ## :spiral_notepad: Features
+ multi-config repo, with configs for servers, laptop, and desktop - multi-config repo, with configs for servers, laptop, and desktop
+ multi-system home-manager setup - multi-system home-manager setup
+ secrets provisioning with [sops-nix](https://github.com/Mic92/sops-nix) - secrets provisioning with [sops-nix](https://github.com/Mic92/sops-nix)
+ multiple fully declarative self hosted services (and some containerized ones, with a docker backend) - multiple fully declarative self hosted services (and some containerized ones, with a docker backend)
+ wayland config for hyprland - wayland config for hyprland
+ custom packages not found in nixpkgs - custom packages not found in nixpkgs
+ linted & styled with [alejandra](https://github.com/kamadorueda/alejandra), [deadnix](https://github.com/astro/deadnix), and [statix](https://github.com/nerdypepper/statix) - linted & styled with [alejandra](https://github.com/kamadorueda/alejandra), [deadnix](https://github.com/astro/deadnix), and [statix](https://github.com/nerdypepper/statix)
## :busts_in_silhouette: Credit ## :busts_in_silhouette: Credit
#### people who've inspired me to dive into nix, and i've stolen stuff from (you guys are awesome!) #### people who've inspired me to dive into nix, and i've stolen stuff from (you guys are awesome!)
+ [fufexan](https://github.com/fufexan) - a ton of home manager, hyprland stuff, and some gh workflows
+ [Misterio77](https://github.com/Misterio77) - flake, and some other boilerplate - [fufexan](https://github.com/fufexan) - a ton of home manager, hyprland stuff, and some gh workflows
+ [NobbZ](https://github.com/NobbZ) - general nix assistance - [Misterio77](https://github.com/Misterio77) - flake, and some other boilerplate
+ [MatthiasBenaets](https://github.com/MatthiasBenaets) - amazing nixos introduction video - [NobbZ](https://github.com/NobbZ) - general nix assistance
+ [sioodmy](https://github.com/sioodmy) - general dotfile, readme badges, and hyprland stuff - [MatthiasBenaets](https://github.com/MatthiasBenaets) - amazing nixos introduction video
+ [MatthewCroughan](https://github.com/MatthewCroughan) - traefik config used as reference - [sioodmy](https://github.com/sioodmy) - general dotfile, readme badges, and hyprland stuff
+ [seqizz](https://github.com/seqizz/nixos-config/blob/3ee51f406a8c7aa3afde9cdee97a43641b2ed2ef/modules/server/rustypaste.nix) - rustypaste config - [MatthewCroughan](https://github.com/MatthewCroughan) - traefik config used as reference
+ [Yavko](https://github.com/yavko) - ironbar config used as reference - [seqizz](https://github.com/seqizz/nixos-config/blob/3ee51f406a8c7aa3afde9cdee97a43641b2ed2ef/modules/server/rustypaste.nix) - rustypaste config
+ [hlissner](https://github.com/hlissner) - [security.nix](modules/security.nix) - [Yavko](https://github.com/yavko) - ironbar config used as reference
+ [noc](https://git.flake.sh/noc) - networking diagram + a ton of other stuff - [hlissner](https://github.com/hlissner) - [security.nix](modules/security.nix)
- [noc](https://git.flake.sh/noc) - networking diagram + a ton of other stuff

View file

@ -2,27 +2,27 @@
the home of my dotfiles. configured in, and managed by home-manager. the home of my dotfiles. configured in, and managed by home-manager.
name | description | name | description |
--------------- | ----------- | ---------------- | -------------------------------------------------------------------------- |
`ags` | aylurs gtk shell | `ags` | aylurs gtk shell |
`anyrun` | wayland native application launcher | `anyrun` | wayland native application launcher |
`cava` | terminal audio visualizer | `cava` | terminal audio visualizer |
`direnv` | a shell extension, that loads environment variables in certain directories | `direnv` | a shell extension, that loads environment variables in certain directories |
`editors` | houses my main editors, helix and nvim | `editors` | houses my main editors, helix and nvim |
`default` | used for commonly shared modules, for multiple home-manager configs | `default` | used for commonly shared modules, for multiple home-manager configs |
`git` | version control system | `git` | version control system |
`gtk` | themes | `gtk` | themes |
`helix` | modal text editor | `helix` | modal text editor |
`ironbar` | wayland specific bar, written in Rust | `ironbar` | wayland specific bar, written in Rust |
`lazygit` | terminal based git command system | `lazygit` | terminal based git command system |
`mako` | a lightweight wayland notification daemon | `mako` | a lightweight wayland notification daemon |
`neofetch` | fetch program | `neofetch` | fetch program |
`nushell` | my shell of choice | `nushell` | my shell of choice |
`spotify-player`| terminal music player for spotify | `spotify-player` | terminal music player for spotify |
`starship` | shell prompt | `starship` | shell prompt |
`wayland` | has my hyprland config, along with session variables for wayland | `wayland` | has my hyprland config, along with session variables for wayland |
`wezterm` | my terminal of choice | `wezterm` | my terminal of choice |
`yazi` | terminal file manager | `yazi` | terminal file manager |
`zathura` | pdf viewer | `zathura` | pdf viewer |
`zellij` | terminal multiplexer | `zellij` | terminal multiplexer |
`zoxide` | a smarter cd command | `zoxide` | a smarter cd command |

View file

@ -2,17 +2,17 @@
my different hosts, each with their own unique configurations and purposes. my different hosts, each with their own unique configurations and purposes.
Name | Description | Name | Description |
--------------- | ----------- | --------- | --------------------------------------------------------------------------------------------------------------- |
`ame` | T480 laptop, mainly used for experimenting atm | `ame` | T480 laptop, mainly used for experimenting atm |
`arashi` | postgres / redis vm | `arashi` | postgres / redis vm |
`haru` | adblocker / DNS proxy vm | `haru` | adblocker / DNS proxy vm |
`kariru` | *arr stack / seedbox vm | `kariru` | \*arr stack / seedbox vm |
`kaze` | s3 storage ran on a [buyvm slice](https://buyvm.net/kvm-dedicated-server-slices/), with block storage attached. | `kaze` | s3 storage ran on a [buyvm slice](https://buyvm.net/kvm-dedicated-server-slices/), with block storage attached. |
`sakura` | main vm, hosting most internet connected services | `sakura` | main vm, hosting most internet connected services |
`sora` | hetzner vps | `sora` | hetzner vps |
`tsuki` | main machine running hyprland | `tsuki` | main machine running hyprland |
`tsuru` | vm for ci/cd runners, and (potentially) a binary cache | `tsuru` | vm for ci/cd runners, and (potentially) a binary cache |
`yuki` | my old proxmox machine, now running pure nix | `yuki` | my old proxmox machine, now running pure nix |
`default` | defines `nixosConfigurations` | `default` | defines `nixosConfigurations` |
`deploy` | defines deployment nodes for deploy-rs | `deploy` | defines deployment nodes for deploy-rs |

View file

@ -2,16 +2,16 @@
this directory hosts some common modules / services / security tweaks used on (most) hosts. this directory hosts some common modules / services / security tweaks used on (most) hosts.
name | description | name | description |
--------------- | ----------- | ---------------- | ---------------------------------------------------------------------------------- |
`prometheus` | has default prometheus config for all hosts, along with exporters for select hosts | `prometheus` | has default prometheus config for all hosts, along with exporters for select hosts |
`default` | used for commonly shared modules | `default` | used for commonly shared modules |
`fonts` | font handling | `fonts` | font handling |
`nix` | common nix configuration | `nix` | common nix configuration |
`openssh` | configures openssh options | `openssh` | configures openssh options |
`security` | stolen from [hlissner](https://github.com/hlissner) | `security` | stolen from [hlissner](https://github.com/hlissner) |
`sops` | configures sops-nix | `sops` | configures sops-nix |
`system` | commonly shared system settings | `system` | commonly shared system settings |
`time` | force sets the time on all systems | `time` | force sets the time on all systems |
`users` | defines all hosts users & groups | `users` | defines all hosts users & groups |
`virtualisation`| basic docker configuration | `virtualisation` | basic docker configuration |

View file

@ -2,8 +2,8 @@
this directory hosts derivations of packages not found in nixpkgs, and overrides. this directory hosts derivations of packages not found in nixpkgs, and overrides.
name | description | name | description |
--------------- | ----------- | -------------- | ---------------------------------------------------------------------------------------------- |
`chatterino7` | [7tv fork](https://github.com/SevenTV/chatterino7) of chatterino2, a chat client for twitch.tv | `chatterino7` | [7tv fork](https://github.com/SevenTV/chatterino7) of chatterino2, a chat client for twitch.tv |
`jellyfin-rpc` | [discord rpc client](https://github.com/Radiicall/jellyfin-rpc) for jellyfin | `jellyfin-rpc` | [discord rpc client](https://github.com/Radiicall/jellyfin-rpc) for jellyfin |
`overlays.nix` | has overlays that i use | `overlays.nix` | has overlays that i use |

View file

@ -1,3 +1,3 @@
# :lock: secrets # :lock: secrets
houses my secrets, managed with [sops-nix](https://github.com/Mic92/sops-nix) houses my secrets, managed with [sops-nix](https://github.com/Mic92/sops-nix)