Skip to content

🚁 Automatically updated documentation and information about code symbols in a split window

Notifications You must be signed in to change notification settings

byzf/hoversplit.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

11 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🚁 HoverSplit

hoversplit

Overview

A Neovim plugin designed to enhance the Language Server Protocol (LSP) experience by providing hover information in a split window. With this plugin, it is possible to quickly access additional context, documentation, or information related to code symbols directly within Neovim without disrupting your workflow.

Features

  • Hover Information: Get detailed hover information about symbols, functions, types, and more in a separate split window.
  • Auto Update: The content automatically updates as the cursor moves to new targets.
  • Toggle Splits: Easily toggle the split window open and closed using configurable key bindings.

Installation

Install hoversplit.nvim using any preferred plugin manager. LazyVim Example:

{
  "roobert/hoversplit.nvim",
  config = function()
    require("hoversplit").setup({
      autoupdate = false,
      -- close when cursor leave current window
      autoclose = true,
      max_size = 0.3,
      -- :h nvim_open_win()
      winconfig = {
        split = 'below',
        height = 15,
      },
    })
  end
}

Usage

Key Bindings

Configure key bindings for different functionalities. Example configuration:

{
  "roobert/hoversplit.nvim",
  config = function()
    vim.keymap.set('n', '<leader>h', function() require('hoversplit').toggle() end)
  end,
}

Functions

  • show
  • close
  • toggle

About

🚁 Automatically updated documentation and information about code symbols in a split window

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages