mirror of
https://github.com/prdlk/dotfiles.git
synced 2026-11-03 11:37:36 +00:00
docs(docs): add vicinae documentation and update references
This commit is contained in:
1 parent
958a7a8e45
commit
fd1e822450
15 files changed
+119
-34
No files matched your search
@@ -40,7 +40,7 @@ The `*Once` functions only prompt when the key is missing from the existing conf
|
||||
|
||||
### Machine roles
|
||||
|
||||
| Role | Intended platform | Linux desktop layer | Desktop packages (`niri`, `xdg-user-dirs`, `noctalia-shell`) |
|
||||
| Role | Intended platform | Linux desktop layer | Desktop packages (`niri`, `xdg-user-dirs`, `noctalia-shell`, `vicinae-bin`) |
|
||||
| --- | --- | --- | --- |
|
||||
| `desktop` | Arch Linux | Applied | Installed |
|
||||
| `laptop` | Arch Linux | Applied | Installed |
|
||||
|
||||
@@ -38,7 +38,7 @@ One manifest per platform, plus a `shared` block. Any edit to the file changes t
|
||||
| Source | Packages |
|
||||
| --- | --- |
|
||||
| pacman | `niri`, `xdg-user-dirs` |
|
||||
| AUR | `noctalia-shell` |
|
||||
| AUR | `noctalia-shell`, `vicinae-bin` |
|
||||
|
||||
</Tab>
|
||||
<Tab title="macOS">
|
||||
@@ -163,7 +163,7 @@ See [bash and zsh](/shell) for the rest of those files.
|
||||
| `e.d` | `cd ~/.config/dotstate/storage/Rogz/.config && yazi` | not defined |
|
||||
| `e.f` | `cd ~/.config/fish && yazi` | `cd ~/.local/share/chezmoi/dot_config/fish && yazi` |
|
||||
| `e.h` | not defined | `cd ~/.local/share/chezmoi/dot_config/hypr && yazi` |
|
||||
| `e.k` | `yazi ~/.config/kitty` | `yazi ~/.local/share/chezmoi/dot_config/kitty` |
|
||||
| `e.k` | `yazi ~/.config/kitty` | ✓ |
|
||||
| `e.n` | `yazi ~/.config/niri` | `yazi ~/.local/share/chezmoi/dot_config/niri` |
|
||||
| `e.y` | `yazi ~/.config/yazi` | ✓ |
|
||||
| `e.t` | `nvim ~/.config/tmux/tmux.conf` | ✓ |
|
||||
|
||||
@@ -58,6 +58,8 @@ Per-app config repos, one file each in `.chezmoiexternals/<app>.toml`. Each is a
|
||||
| `tmux-palette.toml` | `~/.config/tmux-palette` | [prdlk/tmux-palette](https://github.com/prdlk/tmux-palette) |
|
||||
| `television.toml` | `~/.config/television` | [prdlk/television](https://github.com/prdlk/television) |
|
||||
| `yazi.toml` | `~/.config/yazi` | [prdlk/yazi](https://github.com/prdlk/yazi) |
|
||||
| `kitty.toml` | `~/.config/kitty` | [prdlk/kitty](https://github.com/prdlk/kitty) |
|
||||
| `ghostty.toml` | `~/.config/ghostty` | [prdlk/ghostty](https://github.com/prdlk/ghostty) |
|
||||
|
||||
Edit these in place under `~/.config/<app>`, then commit and push from that checkout.
|
||||
|
||||
@@ -162,12 +164,3 @@ See [Desktop](/desktop/niri) for what the layer contains. Gaps in the gate: the
|
||||
```
|
||||
|
||||
noctalia writes plugin state containing embedded tokens here. These paths are ignored on every machine so tokens are never pulled into the repo.
|
||||
|
||||
### Python byte-cache
|
||||
|
||||
```txt
|
||||
.config/kitty/__pycache__
|
||||
.config/kitty/__pycache__/**
|
||||
```
|
||||
|
||||
kitty imports `tab_bar.py` and the other Python helpers in `~/.config/kitty`, and Python writes `__pycache__` next to them. In symlink mode that directory would otherwise appear in the source tree.
|
||||
@@ -107,7 +107,7 @@ chezmoi encodes target names and attributes in source file names. These are the
|
||||
| `executable_` | Target gets the executable bit | 44 files: every script in `dot_local/bin/` (including `executable_tmux-niri-title`) and `dot_config/niri/scripts/` |
|
||||
| `exact_` | Directory is exact: entries in the target that are not in the source are deleted | `dot_config/niri/exact_config.d/` (numbered `10-…kdl` through `95-…kdl` fragments) |
|
||||
| `empty_` | File is kept even when empty | `dot_config/herdr/empty_dot_plugins.lock` |
|
||||
| `symlink_` | Target is a symlink; file content is the link destination | `dot_config/kitty/symlink_current-theme.conf` (→ `themes/cyberdream.conf`) |
|
||||
| `symlink_` | Target is a symlink; file content is the link destination | None currently |
|
||||
| `.tmpl` | Rendered with Go templates and chezmoi data | `dot_gitconfig.tmpl`, `dot_config/shell/aliases.sh.tmpl`, all scripts, the config and ignore files |
|
||||
| `run_once_` / `run_onchange_` + `before_` / `after_` | Script, with run frequency and phase | See [Apply scripts](/chezmoi/scripts) |
|
||||
|
||||
@@ -119,7 +119,7 @@ Prefixes stack in chezmoi's fixed order, e.g. `private_dot_foo`, `executable_dot
|
||||
|
||||
What that means in practice:
|
||||
|
||||
- Editing a plain file in `$HOME` (for example `~/.config/kitty/kitty.conf`) edits `~/.local/share/chezmoi/dot_config/kitty/kitty.conf` directly. The change is live and shows up in `git status` of the repo with no `chezmoi add` step.
|
||||
- Editing a plain file in `$HOME` (for example `~/.config/niri/config.kdl`) edits `~/.local/share/chezmoi/dot_config/niri/config.kdl` directly. The change is live and shows up in `git status` of the repo with no `chezmoi add` step.
|
||||
- Templates are rendered copies. Editing `~/.gitconfig` or `~/.config/shell/aliases.sh` changes only the copy; the next `chezmoi apply` overwrites it. Edit the `.tmpl` source (`chezmoi edit ~/.gitconfig`) instead.
|
||||
- `private_` and `executable_` targets are real files too. After editing one in place, run `chezmoi re-add <path>` to copy it back into the source.
|
||||
- Tools that rewrite their own config write through the symlink into the repo. The runtime state that would otherwise pollute the source (plugin dirs, lock files, `fish_variables`, `__pycache__`) is excluded in `.chezmoiignore.tmpl` and `.gitignore`; see [Externals and ignore rules](/chezmoi/externals-and-ignore).
|
||||
|
||||
Reference in new issue
Block a user