LVIM HELPER

Neovim plugin written in Lua. Show your custom help files.

Screenshot

Requirements

• neovim (>=0.8.0)
• nui.nvim
• nvim-notify

Install

use({
	"lvim-tech/lvim-helper",
	config = function()
		require("lvim-helper").setup({
			content = {
				{
					type = "separator",
					title = " THIS IS SEPARATOR ",
				},
				{
					type = "link",
					title = "  TITLE LINK 1  ",
					file = "/path/to/file1.md",
					file_type = "markdown",
				},
				{
					type = "link",
					title = "  TITLE LINK 2  ",
					file = "/path/to/file2.md",
					file_type = "markdown",
				},
				{
					type = "separator",
					title = " THIS IS SEPARATOR ",
				},
				{
					type = "link",
					title = "  TITLE LINK 3  ",
					file = "/path/to/file3.md",
					file_type = "markdown",
				},
				{
					type = "link",
					title = "  TITLE LINK 4  ",
					file = "/path/to/file4.md",
					file_type = "markdown",
				},
			},
			border_style_menu = { " ", " ", " ", " ", " ", " ", " ", " " },
			border_style_preview = { " ", " ", " ", " ", " ", " ", " ", " " },
		})
	end,
})

Command

:LvimHelper

Keymaps

Key	Description
<Esc>, q, <C-c>e, <C-c>x, <C-c>d	Close
<C-d>	Scroll Down Preview
<C-u>	Scroll Up Preview
l	Switch Layout ('row' or 'col')
h	Help for Lvim Helper