nvim-docs-view
A Neovim plugin that displays LSP hover documentation in a resizable side panel for better code reference.
What is nvim-docs-view?
nvim-docs-view is a Neovim plugin that displays Language Server Protocol hover documentation in a persistent side panel instead of temporary popups. It solves the problem of documentation disappearing when moving the cursor, providing a dedicated space for reference material while coding. The plugin is inspired by VSCode's Docs View extension and brings similar functionality to the Neovim ecosystem.
Neovim users who work with LSP-enabled languages and want persistent, readable documentation access without interrupting their editing flow. Particularly valuable for developers who reference documentation frequently while coding.
Developers choose nvim-docs-view because it provides a cleaner, more persistent documentation viewing experience compared to Neovim's default hover windows. Its customizable panel positioning and update modes offer flexibility that integrates seamlessly into different workflows.
Overview
A neovim plugin to display lsp hover documentation in a side panel.
Use Cases
Best For
- Reading lengthy documentation without it disappearing on cursor movement
- Keeping API references visible while implementing complex functions
- Neovim users transitioning from VSCode who miss the Docs View panel
- Working with languages that have extensive type documentation via LSP
- Pair programming or teaching where documentation needs to stay visible
- Referencing multiple documentation entries simultaneously during development
Not Ideal For
- Developers working on small screens who need to maximize editor space and avoid persistent side panels.
- Projects that do not use Language Server Protocol or have minimal LSP integration.
- Users who prefer documentation to appear in floating windows or inline popups for temporary reference.
Pros & Cons
Pros
Displays LSP hover content in a fixed side window that stays open during navigation, reducing context switching by keeping docs visible while coding.
Allows the panel to be placed on right, left, top, or bottom with adjustable width and height, offering flexibility for different editor layouts as per the setup options.
Supports both automatic updates on cursor movement and manual control via the :DocsViewUpdate command, catering to varied workflow preferences.
Brings the convenient side panel documentation viewing from VSCode's Docs View extension to Neovim, easing the transition for developers familiar with that ecosystem.
Cons
Limited to displaying documentation from LSP hover responses, so it cannot show help from other sources like Neovim's built-in :help or external documentation tools.
The side panel consumes screen space continuously, which can be intrusive for users with limited monitor space or those who prefer a clean, distraction-free interface.
Lacks advanced features such as search within documentation, syntax highlighting customization, or integration with other plugins, reflecting its focused, minimal philosophy.
Open Source Alternative To
nvim-docs-view is an open-source alternative to the following products:
Frequently Asked Questions
Related Projects
nvim-lspconfigQuickstart configs for Nvim LSP
lspsaga.nvimimprove neovim lsp experience
none-ls.nvimnull-ls.nvim reloaded / Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
rustaceanvim🦀 Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.