tiyn/nvim-docs-view
1
0
Fork 0
mirror of https://github.com/tiyn/nvim-docs-view.git synced 2025-11-13 05:49:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: add update_mode option and :DocsViewUpdate, closes #6

Browse Source
This commit is contained in:
amrbashir
2023-02-12 00:41:55 +02:00
parent 6981376235
commit 601d7f6a2e
2 changed files with 93 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,6 +1,7 @@
# nvim-docs-view
A neovim plugin to display lsp hover documentation in a side panel.
> Inspired by the VSCode extension [Docs View](https://marketplace.visualstudio.com/items?itemName=bierner.docs-view).
<img alt="doc-view-example" src="demo.gif" width="500" />
@@ -36,10 +37,32 @@ lua << EOF
EOF
```
## Usage
## Options
Use `:DocsViewToggle` to open/close the docs view panel
- `position`:
- description: Determines where to open the docs view panel.
- type: `string`
- default: `right`
- possible: `right` | `left` | `top` | `bottom`
- `height`:
- description: Hieght of the docs view panel when position is set to `top` or `bottom`
- type: `number`
- default: `10`
- `width`:
- description: Width of the docs view panel when position is set to `right` or `left`
- type: `number`
- default: `60`
- `update_mode`:
- description: Determines the mechanism used to update the docs view panel content. If `auto`, the content will update upon cursor move. If `manual`, the content will only update once `:DocsViewUpdate` is called.
- type: `string`
- default: `auto`
- possible: `auto` | `manual`
## Commands
- `:DocsViewToggle` to open/close the docs view panel.
- `:DocsViewUpdate` to manually update the docs view panel (will open the docs view panel if necessary).
## LICENSE
[MIT](./LICENSE) © Amr Bashir
[MIT](./LICENSE) © Amr Bashir