Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amrbashir/nvim-docs-view
A neovim plugin to display lsp hover documentation in a side panel.
https://github.com/amrbashir/nvim-docs-view
neovim neovim-plugin nvim nvim-lsp
Last synced: 9 days ago
JSON representation
A neovim plugin to display lsp hover documentation in a side panel.
- Host: GitHub
- URL: https://github.com/amrbashir/nvim-docs-view
- Owner: amrbashir
- License: mit
- Created: 2022-05-13T15:43:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T04:08:44.000Z (3 months ago)
- Last Synced: 2024-10-19T12:36:21.767Z (20 days ago)
- Topics: neovim, neovim-plugin, nvim, nvim-lsp
- Language: Lua
- Homepage:
- Size: 512 KB
- Stars: 147
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - amrbashir/nvim-docs-view - Display LSP hover documentation in a side panel. (LSP / (requires Neovim 0.5))
README
[](https://techforpalestine.org/learn-more)
# 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).
## Installation
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"amrbashir/nvim-docs-view",
opt = true,
cmd = { "DocsViewToggle" },
config = function()
require("docs-view").setup {
position = "right",
width = 60,
}
end
}
```
Using [vim-plug](https://github.com/junegunn/vim-plug)
```viml
Plug 'amrbashir/nvim-docs-view', { 'on': 'DocsViewToggle'}
lua << EOF
require("docs-view").setup {
position = "right",
width = 60,
}
EOF
```
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"amrbashir/nvim-docs-view",
lazy = true,
cmd = "DocsViewToggle",
opts = {
position = "right",
width = 60
}
}
```
## Options
- `position`:
- description: Determines where to open the docs view panel.
- type: `string`
- default: `right`
- possible: `right` | `left` | `top` | `bottom`
- `height`:
- description: Height 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