Skip to content

Commit cf23688

Browse files
Abdulkader-SafiAbdulkader-Safi
committed
Add docs #3
1 parent da98ab7 commit cf23688

File tree

1 file changed

+125
-33
lines changed

1 file changed

+125
-33
lines changed

‎docs/README.md

Lines changed: 125 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,55 @@
44

55
General Commands
66

7-
| Key | Mode | Description |
8-
| :-------- | :----- | :----------------------------- |
9-
| leader nh | normal | Clear search highlights |
10-
| leader os | normal | Source new updates |
11-
| leader + | normal | Increment number |
12-
| leader - | normal | Decrement number |
13-
| leader sv | normal | Split window vertically |
14-
| leader sh | normal | Split window horizontally |
15-
| leader se | normal | Make splits equal size |
16-
| leader sx | normal | Close current split |
17-
| leader to | normal | Open new tab |
18-
| leader tx | normal | Close current tab |
19-
| leader tn | normal | Go to the next tab |
20-
| leader tp | normal | Go to the previous tab |
21-
| leader tf | normal | Open current buffer in new tab |
22-
| ctrl h | normal | Go to the left window |
23-
| ctrl l | normal | Go to the right window |
24-
| ctrl j | normal | Go to the top window |
25-
| ctrl k | normal | Go to the bottom window |
7+
| Key | Mode | Description |
8+
| :-------- | :----- | :------------------------------ |
9+
| leader nh | normal | Clear search highlights |
10+
| leader os | normal | Source new updates |
11+
| leader + | normal | Increment number |
12+
| leader - | normal | Decrement number |
13+
| leader sv | normal | Split window vertically |
14+
| leader sh | normal | Split window horizontally |
15+
| leader se | normal | Make splits equal size |
16+
| leader sx | normal | Close current split |
17+
| leader sm | normal | Maximize/Minimize current split |
18+
| leader to | normal | Open new tab |
19+
| leader tx | normal | Close current tab |
20+
| leader tn | normal | Go to the next tab |
21+
| leader tp | normal | Go to the previous tab |
22+
| leader tf | normal | Open current buffer in new tab |
23+
| ctrl h | normal | Go to the left window |
24+
| ctrl l | normal | Go to the right window |
25+
| ctrl j | normal | Go to the top window |
26+
| ctrl k | normal | Go to the bottom window |
27+
28+
---
29+
30+
### Nvim tree
31+
32+
File explorer
33+
34+
| Key | Mode | Description |
35+
| :-------- | :----- | :----------------------------------- |
36+
| leader fm | normal | Toggle file explorer |
37+
| leader ef | normal | Toggle file explorer on current file |
38+
| leader er | normal | Refresh file explorer |
2639

2740
---
2841

2942
### LSP
3043

3144
language server protocol
3245

33-
| Key | Mode | Description |
34-
| :-- | :----- | :------------------------ |
35-
| jk | insert | Exit insert mode with jk |
36-
| gd | insert | Show LSP definition |
37-
| gi | insert | Show LSP implementations |
38-
| gR | insert | Show LSP references |
39-
| gt | insert | Show LSP type definitions |
40-
| gD | insert | Go to declaration |
46+
| Key | Mode | Description |
47+
| :-------- | :----- | :------------------------------------------ |
48+
| jk | insert | Exit insert mode with jk |
49+
| gd | normal | Show LSP definition |
50+
| gi | normal | Show LSP implementations |
51+
| gR | normal | Show LSP references |
52+
| gt | normal | Show LSP type definitions |
53+
| gD | normal | Go to declaration |
54+
| K | normal | Show documentation for what is under cursor |
55+
| leader rs | normal | Restart LSP |
4156

4257
---
4358

@@ -47,9 +62,86 @@ for comment / uncomment
4762

4863
| Key | Mode | Description |
4964
| :-- | :----- | :----------------------------------------------------- |
50-
| gc0 | insert | Commend from curser positon to the start of the line |
51-
| gc$ | insert | Commend from curser positon to the end of the line |
52-
| gc} | insert | Commend from curser positon to the next empty line |
53-
| gc} | insert | Commend from curser positon to the previous empty line |
54-
| gcb | insert | Commend Prev word |
55-
| gcc | insert | Commend the current line |
65+
| gc0 | normal | Commend from curser positon to the start of the line |
66+
| gc$ | normal | Commend from curser positon to the end of the line |
67+
| gc} | normal | Commend from curser positon to the next empty line |
68+
| gc} | normal | Commend from curser positon to the previous empty line |
69+
| gcb | normal | Commend Prev word |
70+
| gcc | normal | Commend the current line |
71+
72+
---
73+
74+
### Formater
75+
76+
Code formater
77+
78+
| Key | Mode | Description |
79+
| :-------- | :-------------- | :--------------------------------------------- |
80+
| leader mp | normal / visual | Formate code in current buffer or selcted code |
81+
82+
---
83+
84+
### Linting
85+
86+
Code formater
87+
88+
| Key | Mode | Description |
89+
| :-------- | :----- | :------------------------------- |
90+
| leader mp | normal | Trigger linting for current file |
91+
92+
---
93+
94+
### Markdown
95+
96+
Markdown Preview Toggle
97+
98+
| Key | Mode | Description |
99+
| :---------- | :----- | :-------------------- |
100+
| leader mdss | normal | Start MarkdownPreview |
101+
| leader mdst | normal | Stop MarkdownPreview |
102+
103+
---
104+
105+
### Nvim Surround
106+
107+
> ys iw "" >> this will add a "" around the selected word
108+
109+
> ds "" >> this will remove "" from around the selected word
110+
111+
> ys 8j t <tag> >> this will add <tag></tag> around the selected 8 lines
112+
113+
> ds t >> this will remove the tag that around where the curser is
114+
115+
---
116+
117+
### Telescope
118+
119+
Telescope search
120+
121+
| Key | Mode | Description |
122+
| :-------- | :----- | :------------------------------ |
123+
| leader ff | normal | Fuzzy find files in cwd |
124+
| leader fr | normal | Fuzzy find recent files |
125+
| leader fs | normal | Fuzzy find string in cwd |
126+
| leader fc | normal | Find string under cursor in cwd |
127+
128+
---
129+
130+
### Todos
131+
132+
<!-- TODO: -->
133+
134+
| Key | Mode | Description |
135+
| :-- | :----- | :-------------------- |
136+
| ]t | normal | Next todo comment |
137+
| [t | normal | Previous todo comment |
138+
139+
---
140+
141+
### Diagnostics
142+
143+
| Key | Mode | Description |
144+
| :------- | :----- | :------------------------ |
145+
| leader d | normal | Show list of diagnostics |
146+
| ]d | normal | Go to next diagnostic |
147+
| [d | normal | Go to previous diagnostic |

0 commit comments

Comments
 (0)