Skip to content

Commit 4b7837a

Browse files
committed
[docs] better readme
1 parent e198503 commit 4b7837a

6 files changed

+12
-1
lines changed

assets/code_actions.mov

183 KB
Binary file not shown.

assets/completions.mov

936 KB
Binary file not shown.

assets/definition_jumps.mov

192 KB
Binary file not shown.

assets/diagnostics.mov

3.89 MB
Binary file not shown.

assets/hover.mov

400 KB
Binary file not shown.

readme.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ dynamically tells the char count.
1919

2020
* LSP Spec: [Hover](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover)
2121
* Invocation: `:lua vim.lsp.buf.hover()`
22+
* Demo:
23+
<img src="./assets/hover.mov" width=700>
2224

2325
### 2. Go To Definition
2426
This takes to the definition of the function / method(it is different from
@@ -28,27 +30,36 @@ above where the cursor is at the moment.
2830

2931
* LSP Spec: [Go To Definition](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_definition)
3032
* Invocation: `:lua vim.lsp.buf.definition()`
33+
* Demo:
34+
<img src="./assets/definition_jumps.mov" width=700>
3135

3236
### 3. Code Actions
3337
When there are errors in your project and editor shows options to fix them,
3438
these are the code actions. The server returns with the possible potential
3539
solutions to the problems in the current context. This implementation takes it
3640
quite seriously xD.
3741

42+
3843
* LSP Spec: [Code Actions](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction)
3944
* Invocation: `:lua vim.lsp.buf.code_action()` _or_ `:Telescope diagnostics`
45+
* Demo:
46+
<img src="./assets/code_actions.mov" width=700>
4047

4148
### 4. Completions
4249
These are simply the suggestions which appear as you type. This implementation
4350
provides a couple of suggestions based on typing.
4451

4552
* LSP Spec: [Completion](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_completion)
4653
* Invocation: `:lua vim.lsp.buf.completion()`
54+
* Demo:
55+
<img src="./assets/completions.mov" width=700>
4756

48-
### 4. Diagnostics (Notification)
57+
### 5. Diagnostics (Notification)
4958
These are simply the errors, warnings, hints along with some more info related
5059
to them that editor keeps generating async-ly and shows them in the top right
5160
section (usually). This implementation takes a few funny takes on editors.
5261

5362
* LSP Spec: [Diagnostics](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_publishDiagnostics)
5463
* Invocation: `:lua vim.lsp.diagnostic.get_line_diagnostics()` (these btw get generated in insert mode only)
64+
* Demo:
65+
<img src="./assets/diagnostics.mov" width=700>

0 commit comments

Comments
 (0)