Add Key Shortcuts section to README.md documenting custom Neovim and tmux shortcuts #1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive "Key Shortcuts" section to the README.md file to help users understand and quickly reference the custom key mappings configured in this Neovim setup.
What's Added
The new section documents:
Leader Key Configuration
Space
- Used as prefix for custom mappingsFile Navigation Shortcuts
<leader>pv
(Space then pv) - Opens the file explorer<ctrl-p>
- Fuzzy finder for files<ctrl-f>
- Search text content across filesWindow Navigation
<ctrl-h>
- Navigate to left split<ctrl-j>
- Navigate to bottom split<ctrl-k>
- Navigate to top split<ctrl-l>
- Navigate to right splitTmux Integration
<ctrl-b>
+h/j/k/l
- Navigate between tmux panes in the same directionsAdditional Changes
lua/shadielfares/remap.lua
Benefits
The shortcuts documented match the actual key mappings defined in
lua/shadielfares/remap.lua
, ensuring accuracy and consistency.This pull request was created as a result of the following prompt from Copilot chat.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.