docs(nvim): add documentation for neovim#3
Conversation
going to add more keymaps in future
LilSuperUser
left a comment
LilSuperUser
left a comment
There was a problem hiding this comment.
We need a few changes in the keymap documentation:
- I noticed that you have missed some keymaps that exists in the config. Please add them.
- We should also add a Mode column (to be verbose about what mode the user has to be in to use the keymap
- I noticed one duplicate entry under the General Section, 1st and the 3rd keymaps are same. Adding a column for Mode would fix it.
Lastly, the current structure makes it hard to navigate cause the user would have to scroll a lot to find the desired keymap.
Maybe we should organize it as a webpage or adding an index/table of contents at the top. The main idea is that it should look like a cheatsheet.
Also, I’ve pushed some changes to main, please pull and rebase your branch on top of it.
|
thanks for the input, will do! |
|
additions after your comment:
|
LilSuperUser
left a comment
LilSuperUser
left a comment
There was a problem hiding this comment.
Please check that all the links in the table of contents are working correctly.
Also, I think it would be helpful to add a brief one-line description for each entry so users can quickly understand what functionality or section the link points to.
| - [Splits](#splits) | ||
| - [Snacks](#snacks) | ||
| - [Linting](#linting) | ||
| - [Mini](#mini) |
There was a problem hiding this comment.
The link to Mini section is wrong
| - [Clasp](#clasp) | ||
| - [Oil](#oil) |
There was a problem hiding this comment.
The link to Clasp and Oil section is wrong
| ### Multi-Cursor | ||
| | Function | Keymap | Mode | | ||
| | -------------- | --------------- | ----- | | ||
| | Line Skip Cursor (+1) | `<space>j` | n | | ||
| | Line Skip Cursor (-1) | `<space>k` | n | | ||
|
|
||
| --- | ||
|
|
||
| ### Color-Picker | ||
| | Function | Keymap | Mode | | ||
| | -------------- | --------------- | ----- | | ||
| | Toggle color highlighter | `<leader>cc` | n | | ||
|
|
There was a problem hiding this comment.
Some keymaps are still missing in the documentation.
I suggest taking checking out each plugin's config and then documenting the keymaps. (Not all of the keymaps are shown by which-key plugin
There was a problem hiding this comment.
I'll make sure to make the necessary changes
2 participants
Overview
this PR adds documentation for the nvim dotfiles (config)
majorly all keymaps needed to use the nvim config
Screenshot (Preview)
Note For Maintainers
do tell if any changes are to be made or any specific keymaps need to be added or removed