https://github.com/awaken233/dotfiles
personal dotfiles
https://github.com/awaken233/dotfiles
dotfiles ideavimrc karabiner shell vim zsh
Last synced: about 1 month ago
JSON representation
personal dotfiles
- Host: GitHub
- URL: https://github.com/awaken233/dotfiles
- Owner: awaken233
- Created: 2023-06-20T12:08:23.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2026-02-28T10:10:12.000Z (4 months ago)
- Last Synced: 2026-02-28T15:05:59.585Z (4 months ago)
- Topics: dotfiles, ideavimrc, karabiner, shell, vim, zsh
- Language: Lua
- Homepage:
- Size: 282 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dotfiles
> **Other Languages:** [δΈζ](README.zh-CN.md)
A comprehensive personal dotfiles repository using **Dotbot** for automated configuration management across multiple development environments.
## Features
- π **Automated Setup**: One-command installation using Dotbot
- π§ **Modern CLI Tools**: Integrated with ripgrep, fzf, bat, delta, and starship
- π¨ **Multi-Editor Support**: Configurations for Neovim (LazyVim), Vim, IntelliJ IDEA, and Obsidian
- π **Enhanced Shell**: Zsh with Oh-My-Zsh, syntax highlighting, and custom aliases
- π **File Management**: LF file manager with preview support
- π **Git Workflow**: LazyGit integration with enhanced diff viewing
- β¨οΈ **Keyboard Optimization**: Karabiner Elements configuration for macOS
- π₯οΈ **Terminal Multiplexing**: Tmux with vi keybindings and true color support
## Quick Start
```bash
# Clone the repository
git clone https://github.com/yourusername/dotfiles.git ~/dotfiles
cd ~/dotfiles
# Install all configurations
./install
```
## Project Structure
```
.
βββ install # Main installation script
βββ install.conf.yaml # Dotbot configuration
βββ CLAUDE.md # AI assistant guidance
βββ dotbot/ # Dotbot submodule
β
βββ Shell & Terminal
βββ zshrc # Zsh configuration with Oh-My-Zsh
βββ tmuxconf # Tmux configuration
β
βββ Git & Version Control
βββ gitconfig # Git configuration
βββ gitignore_global # Global gitignore
βββ lazygit_config # LazyGit configuration
β
βββ Editors
βββ lazyvim/ # Neovim (LazyVim) configuration
βββ vimrc # Traditional Vim configuration
βββ ideavimrc # IntelliJ IDEA vim plugin
βββ obsidianvimrc # Obsidian vim plugin
β
βββ Tools & Utilities
βββ lf/ # LF file manager configuration
βββ karabiner/ # Karabiner Elements (macOS)
```
## Configuration Details
### Shell Environment (zshrc)
- **Framework**: Oh-My-Zsh with custom plugins
- **Plugins**: syntax-highlighting, autosuggestions, history-substring-search
- **Prompt**: Starship integration for modern prompt
- **Aliases**: Extensive development aliases for proxy, git, kubectl, maven
- **Functions**: Custom functions like `rgfzf()`, `lg()`, `project_lazygit()`
- **FZF Integration**: Enhanced with bat for file previews
### Git Workflow
- **Pager**: Delta for enhanced diff viewing
- **Configuration**: Conditional includes for work/personal setups
- **LazyGit**: Custom IDE integration commands
- **Global Ignore**: Handles IDE files and build artifacts
### Editor Configurations
#### Neovim (LazyVim)
- Full LazyVim setup with custom plugins
- Located in `lazyvim/` directory
- Modern Lua configuration
#### Traditional Vim
- Classic vim configuration with vim-plug
- Maintained for compatibility
#### IntelliJ IDEA
- Vim keybindings through IdeaVim plugin
- Consistent with other vim configurations
#### Obsidian
- Extensive vim configuration for note-taking
- Optimized for markdown editing
### Terminal and File Management
#### Tmux
- True color support
- Vi key bindings
- Custom status bar
#### LF File Manager
- Preview scripts for various file types
- FZF integration for file search
### macOS Integration
#### Karabiner Elements
- Custom keyboard modifications
- Optimized for development workflow
## Installation Process
The installation is fully automated through Dotbot:
1. **Symbolic Links**: Creates links from repository to appropriate locations
2. **Directory Creation**: Automatically creates necessary directories
3. **Submodule Updates**: Initializes and updates git submodules
4. **Clean Setup**: Removes broken symlinks before installation
## Development Environment
This setup is optimized for:
- **Modern CLI Workflow**: ripgrep, fzf, bat, delta integration
- **Multi-Editor Development**: Consistent vim experience across editors
- **Git-Centric Development**: Enhanced diff viewing and lazy git integration
- **macOS Development**: Native tool integration and keyboard optimization
- **Container Development**: Aliases for proxied and containerized tools
## Key Integration Points
- **Search Experience**: FZF + Ripgrep + Bat for unified search and preview
- **Consistent Prompts**: Starship provides uniform prompt across terminals
- **Enhanced Git**: Delta improves diff viewing in git and lazygit
- **Vim Everywhere**: Consistent vim keybindings across all editors
- **Quick Access**: Shell aliases for rapid tool access
## Customization
To customize for your environment:
1. **Edit Configuration Files**: Modify files in the repository root
2. **Update Mappings**: Edit `install.conf.yaml` for new file locations
3. **Reinstall**: Run `./install` to apply changes
4. **Personal Settings**: Create conditional includes in git config
## Requirements
- **macOS**: Primary support (some configurations are macOS-specific)
- **Zsh**: Required for shell configuration
- **Git**: Required for installation and submodules
- **Python**: Required for Dotbot
## Contributing
This is a personal dotfiles repository, but feel free to:
- Fork and adapt for your own use
- Submit issues for bugs or improvements
- Share interesting configurations or optimizations
## License
MIT License - feel free to use and modify as needed.
---
*This dotfiles setup provides a comprehensive development environment with modern tools and consistent configurations across multiple editors and platforms.*