Skip to content

Commit 388baac

Browse files
authored
docs: add default keybinding maps available in the help (#506)
This is a PATCH change.
1 parent 1584b69 commit 388baac

1 file changed

Lines changed: 81 additions & 0 deletions

File tree

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,84 @@ For a list of all these settings please run `:h gitlab.nvim.configuring-the-plug
122122
The plugin sets up a number of useful keybindings in the special buffers it creates, and some global keybindings as well. Refer to the relevant section of the manual `:h gitlab.nvim.keybindings` for more details.
123123

124124
For more information about each of these commands, and about the APIs in general, run `:h gitlab.nvim.api`
125+
126+
`gitlab.nvim` comes with a set of default `keymaps` for different contexts. You can override any of these in your configuration.
127+
128+
### Global Keymaps
129+
130+
These keymaps are available globally (i.e., in any buffer).
131+
132+
```
133+
g? Open a help popup for local keymaps
134+
glaa Add assignee
135+
glad Delete assignee
136+
glla Add label
137+
glld Delete label
138+
glra Add reviewer
139+
glrd Delete reviewer
140+
glA Approve MR
141+
glR Revoke MR approval
142+
glM Merge the feature branch to the target branch and close MR
143+
glC Create a new MR for currently checked-out feature branch
144+
glc Chose MR for review
145+
glS Start review for the currently checked-out branch
146+
gls Show the editable summary of the MR
147+
glu Copy the URL of the MR to the system clipboard
148+
glo Open the URL of the MR in the default Internet browser
149+
gln Create a note (comment not linked to a specific line)
150+
glp Show the pipeline status
151+
gld Toggle the discussions window
152+
glD Toggle between draft mode and live mode
153+
glP Publish all draft comments/notes
154+
```
155+
156+
#### Popup Keymaps
157+
158+
These `keymaps` are active in the popup windows (e.g., for creating comments, editing the summary, etc.).
159+
160+
```
161+
<Tab> Cycle to the next field
162+
<S-Tab> Cycle to the previous field
163+
ZZ Perform action (e.g., save comment)
164+
ZA Perform linewise action
165+
ZQ Discard changes and quit the popup
166+
```
167+
168+
#### Discussion Tree Keymaps
169+
170+
These `keymaps` are active in the discussion tree window.
171+
172+
```
173+
Ea Add an emoji to the note/comment
174+
Ed Remove an emoji from a note/comment
175+
dd Delete comment
176+
e Edit comment
177+
r Reply to comment
178+
- Toggle the resolved status of the whole discussion
179+
o Jump to comment location in file
180+
a Jump to the comment location in the reviewer window
181+
b Jump to the URL of the current note/discussion
182+
u Copy the URL of the current node to clipboard
183+
c Toggle between the notes and discussions views
184+
i Toggle type of discussion tree
185+
P Publish the currently focused note/comment
186+
dt Toggle between date formats
187+
D Toggle between draft mode and live mode
188+
st Toggle whether discussions are sorted by the "latest_reply", or by "original_comment"
189+
t Open or close the discussion
190+
T Open or close separately both resolved and unresolved discussions
191+
R Open or close all resolved discussions
192+
U Open or close all unresolved discussions
193+
<C-R> Refresh the data in the view
194+
<leader>p Print the current node (for debugging)
195+
```
196+
197+
#### Reviewer Keymaps
198+
199+
These `keymaps` are active in the reviewer window (the diff view).
200+
201+
```
202+
c Create a comment for the lines that the following {motion} moves over
203+
s Create a suggestion for the lines that the following {motion} moves over
204+
a Jump to the comment in the discussion tree
205+
```

0 commit comments

Comments
 (0)