Update
This commit is contained in:
41
docs/APPS.md
41
docs/APPS.md
@@ -1,41 +0,0 @@
|
||||
# Apps and services
|
||||
|
||||
*non-exhaustive lists*
|
||||
|
||||
## Laptop
|
||||
|
||||
The laptop configuration is used by an Omen 16 laptop w/ nvidia and an amd gpu running NixOS.
|
||||
The configurations files can be found in the `hosts/laptop` directory.
|
||||
|
||||
| Category | Name |
|
||||
| --------------------------------------- | -------------- |
|
||||
| WM | Hyprland |
|
||||
| | hyprlock |
|
||||
| | hyprpaper |
|
||||
| | hypridle |
|
||||
| | hyprcursor |
|
||||
| | wlogout |
|
||||
| Bar | hyprpanel |
|
||||
| Terminal | kitty |
|
||||
| Shell | zsh |
|
||||
| | tmux |
|
||||
| | starship |
|
||||
| | bat |
|
||||
| | eza |
|
||||
| | zoxide |
|
||||
| | fzf |
|
||||
| Editor | neovim(nixvim) |
|
||||
| File manager | thunar |
|
||||
| Browser | qutebrowser |
|
||||
| Music | spicetify |
|
||||
| Launcher | wofi |
|
||||
| DM | tuigreet |
|
||||
| Secrets | sops-nix |
|
||||
| See [hosts/laptop](../hosts/laptop/)... | |
|
||||
|
||||
## Server
|
||||
|
||||
The server configuration is used by a home server running NixOS.
|
||||
The configurations files can be found in the `hosts/server` directory.
|
||||
I mainly use it for self-hosting websites and services such as Nextcloud, Vaultwarden, jellyfin, ...
|
||||
I exposed some services to the internet using a reverse proxy (Nginx) and cloudflare-dyndns, others are accessed through a tailscale network
|
||||
@@ -1,6 +1,6 @@
|
||||
# Themes
|
||||
|
||||
Themes are defined in `hosts/themes`. Those themes define the colors, fonts, icons, etc, used by Hyprland and the apps/programs installed.
|
||||
Themes are defined in `themes`. Those themes define the colors, fonts, icons, etc, used by Hyprland and the apps/programs installed.
|
||||
You can change the selected theme by changing the import statement of your host's variables.nix file.
|
||||
|
||||
> [!TIP]
|
||||
@@ -9,7 +9,7 @@ You can change the selected theme by changing the import statement of your host'
|
||||
## Create your theme
|
||||
|
||||
Create a copy of one of the existing themes and change the variables.
|
||||
Wallpapers are loaded from the `home/wallpapers` folder.
|
||||
Wallpapers are loaded from the [nixy-wallpapers](https://github.com/anotherhadi/nixy-wallpapers) repo.
|
||||
|
||||
## Gallery
|
||||
|
||||
|
||||
16
docs/TODO.md
16
docs/TODO.md
@@ -1,13 +1,16 @@
|
||||
# Todolist {
|
||||
# Todolist
|
||||
|
||||
feel free to contribute <3 ([CONTRIBUTING.md](CONTRIBUTING.md))
|
||||
|
||||
- [ ] Hyprshade (replacement for gammastep)
|
||||
- [ ] !!! Qutebrowser Bitwarden integration (I need this.)
|
||||
|
||||
- [ ] Hyprland
|
||||
- [ ] Fix screenshots (screenshot region's border shows up in the screenshot, hyprshot jq error?) and add in the scripts doc
|
||||
|
||||
- [ ] Nixy
|
||||
- [ ] Open Keybindings
|
||||
|
||||
- [ ] Nixvim
|
||||
- [ ] Markdown tab size 2
|
||||
- [ ] Harpoon
|
||||
@@ -16,15 +19,6 @@ feel free to contribute <3 ([CONTRIBUTING.md](CONTRIBUTING.md))
|
||||
- [ ] nvim dap
|
||||
- [ ] <https://github.com/0fie/Mika>
|
||||
- [ ] <https://github.com/redyf/Neve/blob/main/config/utils/whichkey.nix>
|
||||
|
||||
- [ ] Update docs
|
||||
- [ ] Workflow README
|
||||
- [ ] Put wallpapers in a separate repo, with a flake.nix
|
||||
|
||||
## Server
|
||||
|
||||
- [ ] Jackflix V2
|
||||
- Backup Radarr, Prowlarr, Sonarr config
|
||||
- Take a look into buildarr or build a custom solution with *arr apis
|
||||
- [ ] Bitcoin-git: broken
|
||||
- [ ] Secrets mode 0444: not secure
|
||||
- [ ] Adguard config
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
# Wallpapers
|
||||
|
||||
Wallpapers can be found in the `/home/wallpapers` folder.
|
||||
|
||||
| Name | Preview |
|
||||
|-----------------------|--------------------------------------------------------------------|
|
||||
| 20.png |  |
|
||||
| astronaut.png |  |
|
||||
| aurore.png |  |
|
||||
| barcode.png |  |
|
||||
| black-and-white.png |  |
|
||||
| cat-leaves.png |  |
|
||||
| city.png |  |
|
||||
| cloud.png |  |
|
||||
| clouds-2.png |  |
|
||||
| clouds2.png |  |
|
||||
| clouds-3.png |  |
|
||||
| clouds.png |  |
|
||||
| coffee.png |  |
|
||||
| crane.png |  |
|
||||
| dark_cloud.png |  |
|
||||
| dark-forest.png |  |
|
||||
| dark.png |  |
|
||||
| dark-waves.png |  |
|
||||
| degirled.png |  |
|
||||
| diner-lonely-road.png |  |
|
||||
| fuji-dark.png |  |
|
||||
| fuji-light.png |  |
|
||||
| galaxy.png |  |
|
||||
| horizon-2.png |  |
|
||||
| house-cloud.png |  |
|
||||
| key.png |  |
|
||||
| lavender-cat.png |  |
|
||||
| lofi-computer.png |  |
|
||||
| lofi-urban.png |  |
|
||||
| magma.png |  |
|
||||
| mountains-black.png |  |
|
||||
| mountains.png |  |
|
||||
| nasa-japan-dark.png |  |
|
||||
| nix.png |  |
|
||||
| pixel-galaxy.png |  |
|
||||
| problems.png |  |
|
||||
| rains-dark.png |  |
|
||||
| rocket-launch.png |  |
|
||||
| sea2.png |  |
|
||||
| sea.png |  |
|
||||
| space2.png |  |
|
||||
| space.png |  |
|
||||
| street.png |  |
|
||||
| sun.png |  |
|
||||
| the-road-black.png |  |
|
||||
| tokyo.png |  |
|
||||
| train.png |  |
|
||||
| windows.png |  |
|
||||
| wp.png |  |
|
||||
@@ -13,8 +13,3 @@ done
|
||||
for file in ./docs/src/*/*.png; do
|
||||
optipng "$file"
|
||||
done
|
||||
|
||||
# Wallpapers
|
||||
for file in ./home/wallpapers/*.png; do
|
||||
optipng "$file"
|
||||
done
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
|
||||
|
||||
# Create WALLPAPERS.md to preview wallpapers in ./home/wallpapers
|
||||
|
||||
WALLPAPERS_FOLDER="./home/wallpapers"
|
||||
WALLPAPERS_MD="./docs/WALLPAPERS.md"
|
||||
[[ -d "$WALLPAPERS_FOLDER" ]] || (echo "Wallpapers folder not found" && exit 1)
|
||||
|
||||
echo "# Wallpapers" >"$WALLPAPERS_MD"
|
||||
echo "" >>"$WALLPAPERS_MD"
|
||||
echo "Wallpapers can be found in the \`/home/wallpapers\` folder." >>"$WALLPAPERS_MD"
|
||||
echo "" >>"$WALLPAPERS_MD"
|
||||
echo "| Name | Preview |" >>"$WALLPAPERS_MD"
|
||||
echo "| -- | -- |" >>"$WALLPAPERS_MD"
|
||||
|
||||
for file in "$WALLPAPERS_FOLDER"/*.png; do
|
||||
filename=$(basename "$file")
|
||||
echo "| $filename |  |" >>"$WALLPAPERS_MD"
|
||||
done
|
||||
|
||||
pandoc -t commonmark_x "$WALLPAPERS_MD" -o "/tmp/wallpapers.md"
|
||||
mv "/tmp/wallpapers.md" "$WALLPAPERS_MD"
|
||||
@@ -6,22 +6,15 @@
|
||||
|
||||
README_FILE="./README.md"
|
||||
|
||||
header=$(cat "./docs/src/header.md")
|
||||
table_of_content=$(md-table-of-contents ./docs/src/README_template.md) # https://github.com/anotherhadi/md-table-of-contents
|
||||
version=$(git describe --tags --abbrev=0)
|
||||
readme_content=$(cat "./docs/src/README_template.md")
|
||||
description=$(curl -s https://api.github.com/repos/anotherhadi/nixy | jq .description)
|
||||
description="${description%\"}"
|
||||
description="${description#\"}"
|
||||
|
||||
header=${header//\{date\}/$(date '+%D')}
|
||||
header=${header//\{primarycolor\}/89b4fa}
|
||||
header=${header//\{backgroundcolor\}/181825}
|
||||
header=${header//\{version\}/$version}
|
||||
header=${header//\{description\}/$description}
|
||||
# Replace variables
|
||||
readme_content=${readme_content//\{primarycolor\}/89b4fa}
|
||||
readme_content=${readme_content//\{backgroundcolor\}/181825}
|
||||
readme_content=${readme_content//\{md_table_of_content\}/$table_of_content}
|
||||
|
||||
echo "$header" >"$README_FILE"
|
||||
echo "[//]: # (This file is autogenerated)" >"$README_FILE"
|
||||
echo "$readme_content" >>"$README_FILE"
|
||||
sed 's/\r//' "$README_FILE" >"/tmp/readme.md"
|
||||
mv "/tmp/readme.md" "$README_FILE"
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
|
||||
|
||||
TAG=$(git describe --tags --abbrev=0)
|
||||
echo "Current tag: $TAG"
|
||||
|
||||
read -rp "Enter the new tag name: " NEW_TAG
|
||||
|
||||
read -rp "Do you want to compress the png files? [y/N]: " COMPRESS_PNG
|
||||
if [[ "$COMPRESS_PNG" == "y" || "$COMPRESS_PNG" == "Y" ]]; then
|
||||
echo "Compresing png files..."
|
||||
bash ./docs/scripts/compress_png.sh
|
||||
fi
|
||||
|
||||
echo "Creating wallpapers preview..."
|
||||
bash ./docs/scripts/create_preview_wallpapers.sh
|
||||
echo "Creating README.md..."
|
||||
bash ./docs/scripts/create_readme.sh
|
||||
echo "Creating keybindings.md..."
|
||||
bash ./docs/scripts/keybindings_to_markdown.sh
|
||||
|
||||
git add .
|
||||
git commit -m "Release $NEW_TAG"
|
||||
git tag -a "$NEW_TAG" -m "Release $NEW_TAG"
|
||||
git push origin "$NEW_TAG"
|
||||
@@ -1,42 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
[ "$1" = "" ] && echo "Usage: $0 <theme_name>" && exit 1
|
||||
theme_name=$1
|
||||
|
||||
# Switch to workspace 1
|
||||
sleep 2
|
||||
|
||||
# Step 1
|
||||
kitty --class peaclock peaclock &
|
||||
sleep 1
|
||||
menu &
|
||||
sleep 1
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "1.png" -d
|
||||
sleep 2
|
||||
pkill peaclock
|
||||
menu
|
||||
sleep 2
|
||||
|
||||
# Step 2
|
||||
kitty cmatrix &
|
||||
sleep 1
|
||||
kitty &
|
||||
sleep 1
|
||||
qutebrowser &
|
||||
sleep 3
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "2.png" -d
|
||||
sleep 2
|
||||
pkill cmatrix
|
||||
pkill --newest qutebrowser ""
|
||||
pkill --newest kitty
|
||||
sleep 2
|
||||
|
||||
# Step 3
|
||||
kitty cava &
|
||||
sleep 1
|
||||
spotify &
|
||||
sleep 10
|
||||
brightness-down
|
||||
sleep 1
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "3.png" -d
|
||||
sleep 2
|
||||
@@ -1,7 +1,36 @@
|
||||
<div align="center">
|
||||
<img src="https://raw.githubusercontent.com/anotherhadi/nixy/main/docs/src/logo.png" width="100px" />
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
# Nixy
|
||||
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color={primarycolor}&labelColor={backgroundcolor}&style=for-the-badge&logo=starship&logoColor={primarycolor}">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color={primarycolor}&labelColor={backgroundcolor}&style=for-the-badge&logo=github&logoColor={primarycolor}">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor={backgroundcolor}&logo=NixOS&logoColor={primarycolor}&color={primarycolor}">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA={backgroundcolor}&colorB={primarycolor}&logo=unlicense&logoColor={primarycolor}"/>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
|
||||
**Nixy** is a **Hyprland** NixOS configuration with **home-manager**, **secrets**, and **custom theming** all in one place.
|
||||
It's a simple way to manage your system configuration and dotfiles.
|
||||
|
||||
*Key points:*
|
||||
|
||||
- Hyprecosystem first (Hyprland, hyprlock, hyprpanel, hypridle, ...)
|
||||
- Stylix/base16 themes
|
||||
|
||||
## Table of Content
|
||||
|
||||
{md_table_of_content}
|
||||
@@ -25,18 +54,15 @@ Those are the dotfiles and configuration files for user-level configuration
|
||||
- `system` is some "desktop environment" configuration
|
||||
- `wallpapers` are... wallpapers
|
||||
|
||||
### `nixos`
|
||||
|
||||
### `themes`
|
||||
|
||||
### 💻 `hosts`
|
||||
|
||||
Those are the host-specific configurations
|
||||
Each host contains a `configuration.nix` for system-level configuration, a `home.nix` for user-level configuration, and a `variables.nix` for config wide variables.
|
||||
|
||||
**Subfolders:**
|
||||
|
||||
- 🎨 `themes` are the themes available *(see [THEMES.md](docs/THEMES.md))*
|
||||
- 📦 `modules` are the nix modules that you can import
|
||||
- `laptop` is my configuration for my laptop with Nvidia that you can copy
|
||||
- `server` is for my homeserver (w/nextcloud, nginx, vaultwarden, ...)
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
@@ -57,10 +83,9 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname
|
||||
## Documentation
|
||||
|
||||
- [THEMES.md](docs/THEMES.md): How themes work and how to create your own
|
||||
- [APPS.md](docs/APPS.md): Which apps are installed
|
||||
- [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available
|
||||
- [KEYBINDINGS.md](docs/KEYBINDINGS.md): Keybindings available in Hyprland
|
||||
- [WALLPAPERS.md](docs/WALLPAPERS.md): Preview of every wallpapers available
|
||||
- [WALLPAPERS.md](https://github.com/anotherhadi/nixy-wallpapers): A collection of wallpapers for Nixy.
|
||||
|
||||
- [TODO.md](docs/TODO.md): What's next (feel free to contribute)
|
||||
- [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
[//]: # (Title: Nixy)
|
||||
[//]: # (Description: {description})
|
||||
[//]: # (Author: Hadi)
|
||||
[//]: # (Date: {date})
|
||||
[//]: # (Version: {version})
|
||||
|
||||
<div align="center">
|
||||
<img src="https://raw.githubusercontent.com/anotherhadi/nixy/main/docs/src/logo.png" width="100px" />
|
||||
</div>
|
||||
|
||||
<br>
|
||||
|
||||
# Nixy
|
||||
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message={version}&colorA={backgroundcolor}&colorB={primarycolor}&logo=githubactions&logoColor={primarycolor}"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color={primarycolor}&labelColor={backgroundcolor}&style=for-the-badge&logo=starship&logoColor={primarycolor}">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color={primarycolor}&labelColor={backgroundcolor}&style=for-the-badge&logo=github&logoColor={primarycolor}">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor={backgroundcolor}&logo=NixOS&logoColor={primarycolor}&color={primarycolor}">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA={backgroundcolor}&colorB={primarycolor}&logo=unlicense&logoColor={primarycolor}"/>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
Reference in New Issue
Block a user