From 3a3965b4d9e307cbdb7ff047fc00ad2e77d1c7af Mon Sep 17 00:00:00 2001 From: notohh Date: Thu, 1 Feb 2024 17:31:35 -0500 Subject: [PATCH] docs: fmt with prettier --- README.md | 46 +++++++++++++++++++++++---------------------- home/README.md | 48 +++++++++++++++++++++++------------------------ hosts/README.md | 28 +++++++++++++-------------- modules/README.md | 26 ++++++++++++------------- pkgs/README.md | 10 +++++----- secrets/README.md | 2 +- 6 files changed, 81 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index d738e66..cb1bbcf 100755 --- a/README.md +++ b/README.md @@ -25,8 +25,8 @@ ## :open_book: Table of contents -+ :house_with_garden: [home](src/branch/master/home) -+ :computer: [hosts](src/branch/master/hosts) +- :house_with_garden: [home](src/branch/master/home) +- :computer: [hosts](src/branch/master/hosts) - :cloud_with_rain: [ame](src/branch/master/hosts/ame) - :cloud_with_lightning_and_rain: [arashi](src/branch/master/hosts/arashi) - :hibiscus: [haru](src/branch/master/hosts/haru) @@ -37,29 +37,31 @@ - :full_moon: [tsuki](src/branch/master/hosts/tsuki) - :building_construction: [tsuru](src/branch/master/hosts/tsuru) - :snowflake: [yuki](src/branch/master/hosts/yuki) -+ :electric_plug: [modules](src/branch/master/modules) -+ :package: [pkgs](src/branch/master/pkgs) -+ :lock: [secrets](src/branch/master/secrets) +- :electric_plug: [modules](src/branch/master/modules) +- :package: [pkgs](src/branch/master/pkgs) +- :lock: [secrets](src/branch/master/secrets) ## :spiral_notepad: Features -+ multi-config repo, with configs for servers, laptop, and desktop -+ multi-system home-manager setup -+ 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) -+ wayland config for hyprland -+ 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) +- multi-config repo, with configs for servers, laptop, and desktop +- multi-system home-manager setup +- 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) +- wayland config for hyprland +- 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) ## :busts_in_silhouette: Credit + #### 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 -+ [NobbZ](https://github.com/NobbZ) - general nix assistance -+ [MatthiasBenaets](https://github.com/MatthiasBenaets) - amazing nixos introduction video -+ [sioodmy](https://github.com/sioodmy) - general dotfile, readme badges, and hyprland stuff -+ [MatthewCroughan](https://github.com/MatthewCroughan) - traefik config used as reference -+ [seqizz](https://github.com/seqizz/nixos-config/blob/3ee51f406a8c7aa3afde9cdee97a43641b2ed2ef/modules/server/rustypaste.nix) - rustypaste config -+ [Yavko](https://github.com/yavko) - ironbar config used as reference -+ [hlissner](https://github.com/hlissner) - [security.nix](modules/security.nix) -+ [noc](https://git.flake.sh/noc) - networking diagram + a ton of other stuff + +- [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 +- [NobbZ](https://github.com/NobbZ) - general nix assistance +- [MatthiasBenaets](https://github.com/MatthiasBenaets) - amazing nixos introduction video +- [sioodmy](https://github.com/sioodmy) - general dotfile, readme badges, and hyprland stuff +- [MatthewCroughan](https://github.com/MatthewCroughan) - traefik config used as reference +- [seqizz](https://github.com/seqizz/nixos-config/blob/3ee51f406a8c7aa3afde9cdee97a43641b2ed2ef/modules/server/rustypaste.nix) - rustypaste config +- [Yavko](https://github.com/yavko) - ironbar config used as reference +- [hlissner](https://github.com/hlissner) - [security.nix](modules/security.nix) +- [noc](https://git.flake.sh/noc) - networking diagram + a ton of other stuff diff --git a/home/README.md b/home/README.md index 9219c94..270d683 100644 --- a/home/README.md +++ b/home/README.md @@ -2,27 +2,27 @@ the home of my dotfiles. configured in, and managed by home-manager. -name | description ---------------- | ----------- -`ags` | aylurs gtk shell -`anyrun` | wayland native application launcher -`cava` | terminal audio visualizer -`direnv` | a shell extension, that loads environment variables in certain directories -`editors` | houses my main editors, helix and nvim -`default` | used for commonly shared modules, for multiple home-manager configs -`git` | version control system -`gtk` | themes -`helix` | modal text editor -`ironbar` | wayland specific bar, written in Rust -`lazygit` | terminal based git command system -`mako` | a lightweight wayland notification daemon -`neofetch` | fetch program -`nushell` | my shell of choice -`spotify-player`| terminal music player for spotify -`starship` | shell prompt -`wayland` | has my hyprland config, along with session variables for wayland -`wezterm` | my terminal of choice -`yazi` | terminal file manager -`zathura` | pdf viewer -`zellij` | terminal multiplexer -`zoxide` | a smarter cd command +| name | description | +| ---------------- | -------------------------------------------------------------------------- | +| `ags` | aylurs gtk shell | +| `anyrun` | wayland native application launcher | +| `cava` | terminal audio visualizer | +| `direnv` | a shell extension, that loads environment variables in certain directories | +| `editors` | houses my main editors, helix and nvim | +| `default` | used for commonly shared modules, for multiple home-manager configs | +| `git` | version control system | +| `gtk` | themes | +| `helix` | modal text editor | +| `ironbar` | wayland specific bar, written in Rust | +| `lazygit` | terminal based git command system | +| `mako` | a lightweight wayland notification daemon | +| `neofetch` | fetch program | +| `nushell` | my shell of choice | +| `spotify-player` | terminal music player for spotify | +| `starship` | shell prompt | +| `wayland` | has my hyprland config, along with session variables for wayland | +| `wezterm` | my terminal of choice | +| `yazi` | terminal file manager | +| `zathura` | pdf viewer | +| `zellij` | terminal multiplexer | +| `zoxide` | a smarter cd command | diff --git a/hosts/README.md b/hosts/README.md index f182150..c23966e 100644 --- a/hosts/README.md +++ b/hosts/README.md @@ -2,17 +2,17 @@ my different hosts, each with their own unique configurations and purposes. -Name | Description ---------------- | ----------- -`ame` | T480 laptop, mainly used for experimenting atm -`arashi` | postgres / redis vm -`haru` | adblocker / DNS proxy 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. -`sakura` | main vm, hosting most internet connected services -`sora` | hetzner vps -`tsuki` | main machine running hyprland -`tsuru` | vm for ci/cd runners, and (potentially) a binary cache -`yuki` | my old proxmox machine, now running pure nix -`default` | defines `nixosConfigurations` -`deploy` | defines deployment nodes for deploy-rs +| Name | Description | +| --------- | --------------------------------------------------------------------------------------------------------------- | +| `ame` | T480 laptop, mainly used for experimenting atm | +| `arashi` | postgres / redis vm | +| `haru` | adblocker / DNS proxy 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. | +| `sakura` | main vm, hosting most internet connected services | +| `sora` | hetzner vps | +| `tsuki` | main machine running hyprland | +| `tsuru` | vm for ci/cd runners, and (potentially) a binary cache | +| `yuki` | my old proxmox machine, now running pure nix | +| `default` | defines `nixosConfigurations` | +| `deploy` | defines deployment nodes for deploy-rs | diff --git a/modules/README.md b/modules/README.md index 388688f..dcde9bf 100644 --- a/modules/README.md +++ b/modules/README.md @@ -2,16 +2,16 @@ this directory hosts some common modules / services / security tweaks used on (most) hosts. -name | description ---------------- | ----------- -`prometheus` | has default prometheus config for all hosts, along with exporters for select hosts -`default` | used for commonly shared modules -`fonts` | font handling -`nix` | common nix configuration -`openssh` | configures openssh options -`security` | stolen from [hlissner](https://github.com/hlissner) -`sops` | configures sops-nix -`system` | commonly shared system settings -`time` | force sets the time on all systems -`users` | defines all hosts users & groups -`virtualisation`| basic docker configuration +| name | description | +| ---------------- | ---------------------------------------------------------------------------------- | +| `prometheus` | has default prometheus config for all hosts, along with exporters for select hosts | +| `default` | used for commonly shared modules | +| `fonts` | font handling | +| `nix` | common nix configuration | +| `openssh` | configures openssh options | +| `security` | stolen from [hlissner](https://github.com/hlissner) | +| `sops` | configures sops-nix | +| `system` | commonly shared system settings | +| `time` | force sets the time on all systems | +| `users` | defines all hosts users & groups | +| `virtualisation` | basic docker configuration | diff --git a/pkgs/README.md b/pkgs/README.md index 9c4003e..866cc0f 100644 --- a/pkgs/README.md +++ b/pkgs/README.md @@ -2,8 +2,8 @@ this directory hosts derivations of packages not found in nixpkgs, and overrides. -name | description ---------------- | ----------- -`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 -`overlays.nix` | has overlays that i use +| name | description | +| -------------- | ---------------------------------------------------------------------------------------------- | +| `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 | +| `overlays.nix` | has overlays that i use | diff --git a/secrets/README.md b/secrets/README.md index c8f93e0..f9c5f91 100644 --- a/secrets/README.md +++ b/secrets/README.md @@ -1,3 +1,3 @@ # :lock: secrets -houses my secrets, managed with [sops-nix](https://github.com/Mic92/sops-nix) \ No newline at end of file +houses my secrets, managed with [sops-nix](https://github.com/Mic92/sops-nix)