# rockyzhang24/dotfiles architecture

> Architecture diagram of the GitHub repository rockyzhang24/dotfiles, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rockyzhang24/dotfiles
- Repository: https://github.com/rockyzhang24/dotfiles

## Overview

This project is a collection of dotfiles for macOS and Linux systems – a highly modular configuration repository. Its purpose is to provide and manage custom configurations (or “dotfiles”) for a variety of system tools and applications, such as terminal emulators, editors, shells, window managers, file managers, and more. The repository is managed using a “bare” Git repository approach, which avoids the need for symlinks since the dotfiles live directly in the home directory.

##### Main Components
- Central Dotfiles Repository: At the heart of the design is the bare Git repository, which holds all the configuration files.
- Configuration Directories: Organize the key components based on the directory structure, for example:
- Shell: Zsh (with its own subdirectories for completions, keybindings, function scripts, etc.).
- Terminal Emulators: Multiple configurations such as Kitty, Wezterm, and Alacritty (each with dedicated config folders).
- Window Manager and Interaction Tools: yabai and skhd for tiling window management.
- Console File Managers: lf, vifm, and ranger (each with custom configuration files).
- Miscellaneous Tools: Tmux, fzf, Karabiner-Elements, and custom user scripts (located in .config/bin).

##### Relationships and Interactions
- The Dotfiles Repo (bare repository) is the central node. All the various configuration directories (Neovim, Zsh, Kitty, etc.) branch out from it.
- For development tools like Neovim and fzf, show interactions such as plugin management, language server configuration (LSP), and integration with Git.

##### Relevant Technologies and Libraries
- Applications and frameworks by name, for instance:
- Neovim and its ecosystem (plugins, LSP configurations).
- Zsh managed by Zim with Powerlevel10k theme.
- Terminal Emulators: Kitty, WezTerm, Alacritty with custom themes.
- Tiling window manager (yabai) and a keyboard customizer (Karabiner-Elements).
- Tools like Tmux, fzf, and file managers (lf, vifm, ranger).
- Git configuration details for managing the repo with the alias (dot) commands.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Central Components
    DotfilesRepo["Dotfiles Repository (bare Git)"]:::central
    GitAlias["Git Alias Commands (checkout,add,push)"]:::note

    %% Editor Configurations
    subgraph "Editor Configurations"
        Neovim["Neovim Configuration"]:::editor
    end

    %% Shell Configurations
    subgraph "Shell Configurations"
        Zsh["Zsh Configuration"]:::shell
    end

    %% Terminal Emulators
    subgraph "Terminal Emulators"
        Kitty["Kitty Configuration"]:::terminal
        Alacritty["Alacritty Configuration"]:::terminal
        WezTerm["WezTerm Configuration"]:::terminal
    end

    %% Window Management
    subgraph "Window Management"
        Yabai["yabai Configuration"]:::wm
        Skhd["skhd Configuration"]:::wm
    end

    %% Console File Managers
    subgraph "Console File Managers"
        LF["lf Configuration"]:::cfile
        Vifm["vifm Configuration"]:::cfile
        Ranger["ranger Configuration"]:::cfile
    end

    %% Miscellaneous Tools
    subgraph "Miscellaneous Tools"
        Tmux["Tmux Configuration"]:::misc
        Fzf["fzf Configuration"]:::misc
        Karabiner["Karabiner-Elements Configuration"]:::misc
        Scripts["Custom User Scripts"]:::misc
    end

    %% User Terminal Session Node
    UserTerminal["User Terminal Session"]:::usert

    %% Deployment relationships from Dotfiles Repository
    DotfilesRepo -->|"Deploys"| Neovim
    DotfilesRepo -->|"Deploys"| Zsh
    DotfilesRepo -->|"Deploys"| Kitty
    DotfilesRepo -->|"Deploys"| Alacritty
    DotfilesRepo -->|"Deploys"| WezTerm
    DotfilesRepo -->|"Deploys"| Yabai
    DotfilesRepo -->|"Deploys"| Skhd
    DotfilesRepo -->|"Deploys"| LF
    DotfilesRepo -->|"Deploys"| Vifm
    DotfilesRepo -->|"Deploys"| Ranger
    DotfilesRepo -->|"Deploys"| Tmux
    DotfilesRepo -->|"Deploys"| Fzf
    DotfilesRepo -->|"Deploys"| Karabiner
    DotfilesRepo -->|"Deploys"| Scripts
    DotfilesRepo -->|"Utilizes"| GitAlias

    %% Terminal Emulator Configurations applied to User Terminal Session
    Kitty -->|"applies"| UserTerminal
    Alacritty -->|"applies"| UserTerminal
    WezTerm -->|"applies"| UserTerminal

    %% Optional interaction between development tools
    Neovim ---|"integrates"| Fzf

    %% Click events for component mappings
    click Neovim "https://github.com/rockyzhang24/dotfiles/tree/master/.config/nvim"
    click Zsh "https://github.com/rockyzhang24/dotfiles/tree/master/.config/zsh"
    click Kitty "https://github.com/rockyzhang24/dotfiles/tree/master/.config/kitty"
    click Alacritty "https://github.com/rockyzhang24/dotfiles/tree/master/.config/alacritty"
    click WezTerm "https://github.com/rockyzhang24/dotfiles/tree/master/.config/wezterm"
    click Yabai "https://github.com/rockyzhang24/dotfiles/tree/master/.config/yabai"
    click Skhd "https://github.com/rockyzhang24/dotfiles/tree/master/.config/skhd"
    click LF "https://github.com/rockyzhang24/dotfiles/tree/master/.config/lf"
    click Vifm "https://github.com/rockyzhang24/dotfiles/tree/master/.config/vifm"
    click Ranger "https://github.com/rockyzhang24/dotfiles/tree/master/.config/ranger"
    click Tmux "https://github.com/rockyzhang24/dotfiles/tree/master/.config/tmux"
    click Fzf "https://github.com/rockyzhang24/dotfiles/tree/master/.config/fzf"
    click Karabiner "https://github.com/rockyzhang24/dotfiles/tree/master/.config/karabiner"
    click Scripts "https://github.com/rockyzhang24/dotfiles/tree/master/.config/bin"

    %% Styles
    classDef central fill:#ffcc00,stroke:#333,stroke-width:2px
    classDef note fill:#d0f0c0,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5
    classDef editor fill:#add8e6,stroke:#333,stroke-width:2px
    classDef shell fill:#f4a460,stroke:#333,stroke-width:2px
    classDef terminal fill:#dda0dd,stroke:#333,stroke-width:2px
    classDef wm fill:#90ee90,stroke:#333,stroke-width:2px
    classDef cfile fill:#ffb6c1,stroke:#333,stroke-width:2px
    classDef misc fill:#87cefa,stroke:#333,stroke-width:2px
    classDef usert fill:#f08080,stroke:#333,stroke-width:2px
```
