README.md

Motivations

Your dotfiles will most likely be the longest project you ever worked on.

Managing dotfiles without a version control system is a chore. That's why I created this GitHub repo :)

Structure of my dotfiles

.
├── flake.lock
├── flake.nix
├── hammerspoon         # hammerspoon configurations
├── hosts               # hosts (aka. machines) configurations
├── ghostty             # ghostty configurations
├── opencode            # opencode configurations
├── lib                 # utils for Nix
├── users               # user-level configurations
├── nvim                # neovim configurations
├── Rime                # Rime configurations
├── tmux                # tmux configurations
├── README.md
└── windows-only        # Windows configurations

What is inside?

Ghostty

The configurations for Ghostty Terminal.

Hammerspoon

Tip

Install the Fennel and run make to get the corresponding *.lua files.

I use Hammerspoon to manage windows. The available key mappings are:

• Full screen - ⌘ Command + ⌥ Option + f
• Center - ⌘ Command + ⌥ Option + c
• Left half - ⌘ Command + ⌥ Option + ←
• Right half - ⌘ Command + ⌥ Option + →
• Top half - ⌘ Command + ⌥ Option + ↑
• Bottom half - ⌘ Command + ⌥ Option + ↓
• Top left - ⌘ Command + ⌥ Option + ⌃ Control + u
• Top right - ⌘ Command + ⌥ Option + ⌃ Control + i
• Bottom left - ⌘ Command + ⌥ Option + ⌃ Control + j
• Bottom right - ⌘ Command + ⌥ Option + ⌃ Control + k
• Hold to quit any app - ⌘ Command + q

Neovim

My Go-to text editor with the following plugins:

• Package manager: lazy.nvim
• Auto-completion
  • Completion sources: blink.cmp
  • Vscode-like pictograms: lspkind.nvim
  • LSP registry: mason.nvim
• Git related
  • Git integration: vim-fugitive
  • Git decorations: gitsigns.nvim
  • Git diff: diffview.nvim
• Typst tools
  • tinymist
  • typst-preview
• Markdown tools:
  • Markdown previewer (in browser): live-preview.nvim
  • Markdown previewer (within file): render-markdown.nvim
  • Paste image : img-clip.nvim
• Stylish
  • Colorscheme: tokyonight.nvim
  • Better UI for messages/cmdline/popupmenu: noice.nvim
  • TODO highlighting: todo-comments.nvim
• Code editing
  • General capability
    • Treesitter integration: nvim-treesitter
    • Show context at the top: nvim-treesitter-context
    • Syntax aware text-object: nvim-treesitter-textobjects
    • A pretty list for showing diagnostics: trouble.nvim
    • Indentation indicator: indent-blankline
    • Easy motion: flash.nvim
    • Surrounding: nvim-surround
    • Linter: nvim-lint
    • Inline Diagnostics: tiny-inline-diagnostic.nvim
    • Colorful delimiters: rainbow-delimiters.nvim
    • Formatter: conform.nvim
    • REPL-Driven Development: conjure
  • Lisp kind
    • nvim-parinfer: nvim-parinfer
    • nvim-paredit: nvim-paredit
• Integration
  • Use c-h/j/k/l consistently: vim-tmux-navigator
• Fuzzy finders: fzf-lua
• File explorer: mini.files
• Status line: lualine.nvim
• Editor Performance: faster.nvim
• Misc
  • Neovim Tips
  • Hardtime.nvim

Windows-only

I use Mac for personal business but use a Windows PC at work, so I wrote the keymappings.ahk to map keys between Mac and Windows to keep a consistent muscle memory. To use this .ahk script, you need to install the AutoHotKey tool and run keymappings.ahk as administrator. Besides that, you should install a third-party Chinese IME and delete the built-in Microsoft Pinyin IME if you are also a Chinese user because there is an unfixed issue.

nix-darwin

I have been gradually migrating to Nix flakes because I really appreciate the reproducibility they offer. My Nix configuration structure is largely inspired by mitchellh' nixos-config.

Rime

Note

The .lua files under lua/ are generated by the Fennel.

The configuration files for RIME input method in the MacOS.

Appendix

• Home Manager Configuration Options
• The nix-darwin Configuration Options