🚀 My Neovim Configuration

🍰 To be jj cake hand ✋.

⚠️ Important: This is NOT a Neovim distribution. It's my personal configuration that uses many plugins and custom settings. I'm sharing it to inspire others to build their own Neovim setup. Hope it helps!

---

✨ Features

🎨 Beautiful UI Catppuccin theme Dashboard animations Colorful window separators Enhanced lualine
	⚡ Superior Editing Experience Autocompletion with blink.cmp Code navigation with Treesitter Motions with Flash & Hop Text objects & Surround operations
🤖 AI-Powered Development AI code suggestions & NES AI-assisted refactoring AI snippet generation AI sidekick integration
	🔍 Professional Debugging DAP integration with UI Python debugging support Breakpoints & watch expressions Step-through debugging

🌟 Highlights

• 💻 VSCode-Native Editing - Bring Neovim's modal editing to VSCode with motion plugins (Flash, Hop) for Jupyter notebooks and other workflows
• 🌳 JJ-Powered Version Control - Deep integration with Jujutsu (jj), featuring animated status display with conflict detection, bookmark management, and seamless Git compatibility
• 🔧 Cross-Platform Intelligence - Auto-detects system environment (Windows/Mac/Linux) and adapts behavior accordingly
• ✨ Dynamic Dashboard - Animated ASCII art with glitch effects
• 🐍 Python-First Documentation - Custom Neogen templates with Chinese support, auto-extracting parameter defaults, type hints, and return values
• 📓 Full Jupyter Notebook Support - Complete .ipynb editing experience with cell management, kernel control, inline output preview, and REPL integration

---

📸 Screenshots

Copilot AI Intelligent Completion & Next Edit Suggestions

---

Snacks Picker Fuzzy File Search

---

Jujutsu Version Control System Integration

---

Visual Diff Viewer

---

Jupyter Notebook Integration (Bugs)

---

🗂️ Project Structure

~/.config/nvim/
├── init.lua                            # Entry point
├── lazy-lock.json                      # Plugin version lock file
├── stylua.toml                         # Lua formatter config
├── .luarc.json                         # Lua language server config
│
├── lua/
│   ├── config/                         # Core configuration
│   │   ├── autocmds.lua                # Auto commands
│   │   ├── keymaps.lua                 # Key mappings
│   │   ├── lazy.lua                    # Lazy.nvim loader
│   │   ├── lsp.lua                     # LSP configuration
│   │   └── options.lua                 # Neovim options
│   │
│   ├── plugins/                        # Plugin specifications
│   │   ├── ai/                         # AI-related plugins
│   │   ├── core/                       # Core plugins (blink, conform, mason, etc.)
│   │   ├── dap/                        # Debug adapter protocol
│   │   ├── disabled/                   # Disabled plugin configs
│   │   ├── editor/                     # Editor enhancements
│   │   ├── tools/                      # Development tools
│   │   ├── ui/                         # UI plugins
│   │   └── vcs/                        # Version control (git, jj)
│   │
│   ├── neogen/                         # Neogen annotation templates
│   │   └── python/                     # Python-specific templates with Chinese support
│   │
│   └── utils/                          # Utility modules
│       ├── ascii_arts.lua              # ASCII art for dashboard
│       ├── dashboardAnimation.lua      # Dashboard glitch animation
│       ├── debug.lua                   # Debug utilities
│       ├── icons.lua                   # Icon mappings
│       ├── jj_status.lua               # JJ status display
│       ├── snacks_dashboard.lua        # Snacks dashboard config
│       ├── snacks_explorer_preview.lua # Snacks explorer preview
│       └── system.lua                  # System detection
│
├── after/                              # After plugins loaded
├── lsp/                                # LSP server custom configs
├── snippets/                           # Custom snippets
└── docs/                               # Screenshots & images

---

💡 Installation & Usage

Try It

If you want to try this configuration:

# required
mv ~/.config/nvim{,.bak}

# optional but recommended
mv ~/.local/share/nvim{,.bak}
mv ~/.local/state/nvim{,.bak}
mv ~/.cache/nvim{,.bak}

# Clone this configuration
jj git clone https://github.com/RicardoRyn/nvim.git ~/.config/nvim

# Start Neovim
nvim

After the first launch:

1. Check plugins with :Lazy to ensure all plugins are installed correctly
2. Check health with :checkhealth to verify system dependencies and LSP configuration
3. Customize it for your own needs!

💻 VSCode Neovim Integration

This configuration is fully compatible with VSCode Neovim (an extension of VSCode), enabling Neovim-style modal editing in VSCode with compatible Neovim plugins.

Personally, I need to edit Jupyter Notebooks, but Neovim's support for them is quite limited, so I have to use VSCode for that purpose. However, I've become so accustomed to Neovim's modal editing that I can't work efficiently without it. So I tried using Neovim within VSCode, and it works quite well.

Cursor Jumping in VSCode

---

Nvim Plugins in VSCode

Setup

1. Install the VSCode Neovim extension from the VSCode Marketplace.

2. Configure the extension in your VSCode settings (settings.json):

   {
     // vscode-neovim
     "vscode-neovim.neovimClean": false, // Don't clear Neovim configuration
     "extensions.experimental.affinity": {
       "asvetliakov.vscode-neovim": 1 // Neovim extension affinity
     },
     "vscode-neovim.compositeKeys": {
       "jk": {
         "command": "vscode-neovim.escape" // Composite key jk mapped to Escape
       }
     }
   }

3. For a better experience, some keybindings need to be configured in VSCode's keybindings.json. You can refer to my settings for reference.

Available Features in VSCode

Since VSCode has its own built-in UI, terminal, and keybinding system, this configuration only enables efficiency-focused plugins that enhance the editing experience without conflicting with VSCode's native features:

• lazy.nvim - Plugin manager for lazy loading
• mini.ai - Enhanced text objects for smarter editing
• mini.surround - Quick surround operations (add/delete/change)
• nvim-spider - Smart word-wise navigation
• nvim-treesitter-textobjects - Treesitter-based text objects
• flash.nvim & hop.nvim - Fast cursor jumping
• treesj - Code splitting and joining utilities
• yanky.nvim - Enhanced clipboard with history

For the complete list of VSCode-specific keymaps, see the VSCode Keymaps section below.

---

⌨️ Keymaps

Leader Keymaps

Click this

<leader>
├── <Space> (Smart Files)
├── a (AI)
│   ├── a - Toggle Sidekick CLI
│   ├── c - Toggle Sidekick Copilot
│   ├── d - Detach CLI Session
│   ├── f - Send File
│   ├── i - Toggle Sidekick iFlow
│   ├── p - Select Sidekick Prompt (including Visual mode)
│   ├── s - Select CLI
│   ├── t - Send This (including Visual mode)
│   └── v - Send Visual Selection (including Visual mode)
├── b (Buffer)
│   ├── a - Delete All Buffers
│   ├── b - Delete Picked Buffer
│   ├── d - Delete Buffer
│   ├── l - Delete Buffers Left
│   ├── o - Delete Other Buffers
│   ├── p - Toggle Pin
│   ├── P - Delete Unpined Buffers
│   ├── r - Delete Buffers Right
│   ├── < - Move Buffer Left
│   └── > - Move Buffer Right
├── c (Copy/CSV)
│   ├── c - Copy Absolute Path (in Mini Files)
│   ├── d - Copy Directory Path (in Mini Files)
│   ├── f - Copy File Name (in Mini Files)
│   ├── r - Copy Relative Path (in Mini Files)
│   └── sv - Toggle CSV View
├── d (Debug)
│   ├── b - Breakpoint
│   ├── B - Conditional Breakpoint
│   ├── c - Run to Cursor
│   ├── C - Clear Breakpoints
│   ├── d - Disconnect
│   ├── D - Disconnect (Terminate Debuggee)
│   ├── h - Hover
│   ├── i - Step Into
│   ├── k - Step Back
│   ├── o - Step Over
│   ├── O - Step Out
│   ├── q - Terminate Session
│   ├── r - Restart
│   ├── R - Toggle REPL
│   ├── s - Start/Continue
│   ├── u - Toggle UI
│   └── f (Float)
│       ├── e - Float Expression
│       ├── f - Float Frames
│       ├── s - Float Scopes
│       ├── S - Float Sessions
│       └── t - Float Threads
├── D (Dev)
│   └── r (Run lua)
├── e (Explorer)
│   ├── e - Mini Files
│   ├── f - Mini Files (Current File)
│   └── s - File Explorer (for Picture Preview)
├── f (Find)
│   ├── c - Find Config Files
│   ├── f - Find Files
│   ├── g - Find Git Files
│   ├── p - Projects
│   ├── r - Recent Files
│   ├── t - Todo (Buffers)
│   └── T - Todo/Fix (Buffers)
├── g (Git)
│   ├── b - Blame Line
│   ├── B - Blame Buffer
│   ├── p - Preview Hunk Inline
│   ├── P - Preview Hunk (Float)
│   ├── r - Reset Hunk
│   ├── R - Reset Buffer
│   ├── t - Toggle Current Line Blame
│   ├── w - Toggle Word Diff
│   ├── g - LazyGit
│   └── h (Github)
│       ├── i - GitHub Issues (Open)
│       ├── I - GitHub Issues (All)
│       ├── p - GitHub Pull Requests (Open)
│       └── P - GitHub Pull Requests (All)
├── h (Home)
├── j (Jujutsu)
│   ├── a - JJ Annotate File
│   ├── A - JJ Abandon
│   ├── b (Bookmark)
│   │   ├── c - JJ Bookmark Create
│   │   ├── d - JJ Bookmark Delete
│   │   └── m - JJ Bookmark Move
│   ├── C - Conflict
│   ├── d - JJ Diff Current Buffer
│   ├── D - JJ Describe
│   ├── e - JJ Edit
│   ├── f - JJ Fetch
│   ├── l - JJ Log (All)
│   ├── L - JJ Log
│   ├── n - JJ New
│   ├── r - JJ Rebase
│   ├── R - JJ Redo
│   ├── s - JJ Status
│   ├── S - JJ Squash
│   ├── U - JJ Undo
│   ├── p (Push/PR)
│   │   ├── l - JJ open PR from bookmark in current revision or parent
│   │   ├── p - JJ Push
│   │   └── r - JJ open PR from bookmark in current revision or parent
│   └── t - JJ Tug
├── k (Kernel) (Only in Jupyter Notebook)
│   ├── 0 - Restart Kernel
│   ├── a - Insert Cell Above
│   ├── b - Insert Cell Below
│   ├── c - Clear Current Cell Output
│   ├── C - Clear All Outputs
│   ├── f - Toggle Cell Fold
│   ├── h - Inspect Variable at Cursor
│   ├── H - Toggle Auto-Hover
│   ├── i - Interrupt Kernel
│   ├── j - Open Cell Picker
│   ├── m - Convert to Markdown Cell
│   ├── n - Show Kernel Info
│   ├── o - Open Cell Output in Float
│   ├── r - Convert to Raw Cell
│   ├── s - Start Kernel
│   ├── S - Shutdown Kernel
│   ├── v - Show All Variables in Cell
│   ├── x - Execute Cell (Menu)
│   ├── X - Execute and Next (Menu)
│   └── y - Convert to Code Cell
├── l (LSP)
│   ├── a - Code Actions
│   ├── d - Show Diagnostics (Line)
│   ├── D - Show Diagnostics (Buffer)
│   ├── f - Code Format
│   ├── m - Toggle Code Block
│   ├── n - Generate Docstring
│   ├── r - Rename Symbol
│   ├── v - Virtual Env Selector
│   └── sp - Restart LSP
├── L (Lazy)
├── n (Noice)
│   ├── a - All
│   ├── e - Error
│   ├── h - History
│   ├── l - Last Message
│   ├── m - Messages
│   └── n - Noice Picker
├── p (Paste)
├── s (Search/System)
│   ├── b - Buffers
│   ├── c - Commands
│   ├── d - Diagnostics (Buffer)
│   ├── D - Diagnostics
│   ├── h - Help Pages
│   ├── i - Icons
│   ├── I - Incoming Calls
│   ├── j - JJ Picker Status
│   ├── J - Jumps
│   ├── k - Keymaps
│   ├── l - LSP Info
│   ├── L - Search for Plugin Spec
│   ├── m - Marks
│   ├── O - Outgoing Calls
│   ├── p - Spelling
│   ├── P - Pickers
│   ├── r - Resume
│   ├── R - Search and Replace (Grug-far)
│   ├── s - LSP Symbols (Buffer)
│   ├── S - LSP Symbols (Workspace)
│   ├── t - Todo Comments
│   ├── T - Todo/Fix Comments
│   ├── u - Undotree
│   ├── v - Clipboard History
│   ├── " - Registers
│   ├── . - Scratch Select
│   ├── / -
│   └── : - Command Select
├── S (Session)
│   ├── d - Don't Save Current Session
│   ├── l - Restore Last Session
│   ├── s - Restore Session
│   └── S - Select Session
├── t (Tab/Toggle)
│   ├── d - Close Tab
│   ├── n - New Tab
│   └── s - Tab Split
├── u (UI Toggle)
│   ├── b - Toggle Dark Background
│   ├── c - Colorschemes
│   ├── d - Toggle Diagnostics
│   ├── D - Toggle Dim
│   ├── g - Toggle Git Signs
│   ├── h - Toggle Inlay Hints
│   ├── l - Toggle Relative Number
│   ├── L - Toggle Line Number
│   ├── m - Markdown Preview
│   ├── n - Noice Dismiss
│   ├── r - Redraw / Clear hlsearch / Diff Update
│   ├── w - Toggle Wrap
│   ├── z - Toggle Zoom
│   └── Z - Toggle Zen Mode
├── x (Trouble/QuickFix)
│   ├── l - LSP Definitions/References (Trouble)
│   ├── L - Location List (Trouble)
│   ├── Q - Quickfix List (Trouble)
│   ├── s - Symbols (Trouble)
│   ├── x - Diagnostics (Trouble)
│   └── X - Buffer Diagnostics (Trouble)
├── z (Zoxide)
├── . - Scratch
├── : - Command History
├── ? - Buffer Local Keymaps
└── / (Grep)
    ├── b - Grep Buffers
    ├── l - Lines
    ├── w - Grep Word
    └── / - Grep

Other Keymaps

Motion & Navigation

• jk - Exit insert mode
• s - Flash jump/search
• xw / xr - Flash words/resume
• xj / xk / xl / xh - Hop navigation
• Shift+h / Shift+l - Previous/next buffer
• Ctrl+h / Ctrl+j / Ctrl+k / Ctrl+l - Navigate tmux windows
• gd / gD / gr / gI / gy - Goto definition/declaration/references/implementation/type
• ]d / [d - Next/previous diagnostic
• ]g/ gh / [g / gH - Next/previous git hunk

Text Objects

• ciq, dab, yiw - Enhanced text objects
• gsaiw", gsr'", gsd' - Surround operations

Copilot

• Tab - Goto/Apply next edit suggestion
• Ctrl+y / Ctrl+w - Accept Copilot suggestion/word
• Alt+] / Alt+[ - Next/previous Copilot suggestion
• Ctrl+] - Dismiss Copilot suggestion

Terminal

• Ctrl+/ / Ctrl+_ - Open terminal

VSCode Keymaps

<leader>
├── <Space> (Files) - Quick open file
├── ff / <Space> (Files) - Quick open file
├── aa (UI) - Toggle auxiliary bar
├── b (Buffer)
│   ├── d - Close buffer
│   ├── o - Close other buffers
│   ├── a - Close all buffers
│   ├── l - Close buffers to the left
│   ├── r - Close buffers to the right
│   ├── < - Move buffer left
│   └── > - Move buffer right
├── l (LSP)
│   ├── f - Format code
│   ├── r - Rename symbol
│   └── a - Code actions
└── o (Outline)
    ├── o - Focus outline
    └── v - Toggle outline visibility

Motion & Navigation

• s - Flash jump/search
• xw / xr - Flash words/resume
• xj / xk / xl / xh - Hop navigation
• Shift+h - Previous buffer
• Shift+l - Next buffer
• Ctrl+w Ctrl+h / Ctrl+w Ctrl+j / Ctrl+w Ctrl+k /Ctrl+w Ctrl+l - Navigate left/right windows (requires VSCode keybinding config)
• Ctrl+o - Navigate back
• Ctrl+i - Navigate forward
• ]d - Go to next diagnostic
• [d - Go to previous diagnostic

Editing

• Ctrl+d / Ctrl+u - Move cursor down/up 5 lines
• Ctrl+y - Accept inline suggestion

Text Objects

• ciq, dab, yiw - Enhanced text objects
• gsaiw", gsr'", gsd' - Surround operations

Jupyter Notebook Cell Operations

• l - Edit current cell
• y - Copy cell
• p - Paste cell
• Ctrl+Backspace - Clear all cell outputs
• Alt+Backspace - Clear current cell outputs
• Ctrl+j Ctrl+k - Expand/collapse cell input
• Ctrl+Shift+Alt+C - Collapse all cell inputs
• Shift+Alt+Backspace - Restart kernel
• Alt+h / Alt+l - Fold/unfold notebook cell

Terminal

• Ctrl+/ - Toggle built-in terminal
• Ctrl+Shift+= - Toggle maximized panel

---

⭐ If you find this config helpful, please give it a star! ⭐

💬 Feel free to open an issue or submit a PR if you have any ideas or suggestions! 💬