mirror of
https://github.com/tiyn/nvim-docs-view.git
synced 2025-11-13 05:49:45 +01:00
44 lines
821 B
Markdown
44 lines
821 B
Markdown
# 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
|
|
```
|
|
|
|
## Usage
|
|
|
|
Use `:DocsViewToggle` to open/close the docs view side panel
|
|
|
|
## LICENSE
|
|
|
|
[MIT](./LICENSE) License.
|