diff --git a/README.md b/README.md index 5f85150..7d9bda9 100644 --- a/README.md +++ b/README.md @@ -1,86 +1,59 @@ # kickstart.nvim - -Neovim Custom Keymaps - +## Neovim Custom Keymaps A collection of custom keymaps for Neovim aimed at improving productivity, navigation, and clipboard management. These keymaps are written in Lua for Neovim ≥0.7 and include enhanced visual/normal mode operations, smart buffer/file handling, and more. +--- -Features +## Features +### Navigation -[[ Navigation ]] +- Smooth scrolling with centered cursor: `j` / `k` +- Enhanced search: `n` / `N` keeps cursor centered +- Move lines visually: `J` / `K` in visual mode +- Switch between splits quickly: `` / `` +### Buffer & File Management -Smooth scrolling with centered cursor: j / k +- Smart buffer switch using Telescope: `` +- Smart file open (`gf`) reuses empty buffers or opens in a new tab +- Create new empty buffers in splits or tabs: + - Horizontal: `sv` + - Vertical: `sh` + - New tab: `e` +- Save buffers safely: + - `w` — Save current buffer (prompts if new) + - `qy` — Save and quit + - `qn` — Quit without saving -Enhanced search: n / N keeps cursor centered +### Clipboard & Copying -Move lines visually: J / K in visual mode +- Copy current line: `Y` (normal mode) +- Copy selection: `Y` (visual mode, trims extra newlines) +- Select all and copy: `lY` (entire buffer without trailing newline) +- Paste from clipboard: `P` (at cursor, or over selection without yanking it) +- Notifications when content is copied to clipboard -Switch between splits quickly: / +### Diagnostics +- `[d` / `]d` — Navigate diagnostics +- `de` — Open diagnostic floating window +- `dq` — Set location list for diagnostics -[[ Buffer & File Management ]] +### Misc -Smart buffer switch using Telescope: +- Reselect last visual selection after moving lines +- Better word wrap handling: `j` / `k` intelligently move through wrapped lines +- Smart `J` in normal mode joins lines without moving cursor +- Paste over selection without yanking replaced text: `p` -Smart file open (gf) reuses empty buffers or opens in a new tab +--- -Create new empty buffers in splits or tabs: +## Keymaps Overview -Horizontal: sv - -Vertical: sh - -New tab: e - -Save buffers safely: - -w — Save current buffer (prompts if new) - -qy — Save and quit - -qn — Quit without saving - - -[[ Clipboard & Copying ]] - -Copy current line: Y (normal mode) - -Copy selection: Y (visual mode, trims extra newlines) - -Select all and copy: lY (entire buffer without trailing newline) - -Paste from clipboard: P (at cursor, or over selection without yanking it) - -Notifications when content is copied to clipboard - - -[[ Diagnostics ]] - -[d] / ]d — Navigate diagnostics - -de — Open diagnostic floating window - -dq — Set location list for diagnostics - - -[[ Misc ]] - -Reselect last visual selection after moving lines - -Better word wrap handling: j / k intelligently move through wrapped lines - -Smart J in normal mode joins lines without moving cursor - -Paste over selection without yanking replaced text: p - - -Keymaps Overview - -Normal Mode Keymaps: +### Normal Mode Keymaps | Key | Action | Description | | ------------------ | ------------------- | ---------------------------------------------------------------- | @@ -97,8 +70,7 @@ Normal Mode Keymaps: | `` | Smart buffer switch | Open Telescope buffer switcher | | `gf` | Smart file open | Open file under cursor in current/new tab | - -Visual Mode Keymaps: +### Visual Mode Keymaps | Key | Action | Description | | ----------- | -------------- | --------------------------------------------------------- | @@ -107,8 +79,7 @@ Visual Mode Keymaps: | `p` | Paste | Paste over selection without yanking replaced text | | `P` | Paste | Paste from clipboard without replacing selection | - -Split/Window Management: +### Split/Window Management | Key | Action | Description | | --------------- | ---------------- | ------------------------------ | @@ -118,8 +89,7 @@ Split/Window Management: | `` | Switch splits | Switch to next window | | `` | Switch splits | Switch to previous window | - -Diagnostics Keymaps: +### Diagnostics Keymaps | Key | Action | Description | | ------------ | ------------- | ------------------------------------------ | @@ -127,12 +97,13 @@ Diagnostics Keymaps: | `de` | Float | Show diagnostic message in floating window | | `dq` | Location list | Set location list for diagnostics | +--- -Contributing +## Contributing Contributions, bug reports, and suggestions are welcome. Please open an issue or submit a pull request if you have improvements for keymaps, new features, or optimizations. -License +## License MIT License — feel free to use and modify these keymaps in your own Neovim setup.