🧊 Helpview.nvim

A hackable & fancy vimdoc viewer for Neovim.

📖 Table of contents

• ✨ Features

• 📚 Requirements

• 📐 Installation

• 🧭 Configuration

• 🎇 Commands

• 🎨 Highlight groups

✨ Features

• Adds various decorations to make vimdoc files nicer to look at.

• No external dependencies(other than the vimdoc parser)!

• Supports a variety of vimdoc syntaxes such as,

  • Arguments.
  • Code blocks.
  • Headings(& column headings).
  • Highlight group names.
  • Horizontal rules.
  • Inline codes.
  • Keycodes.
  • Vim modeline.
  • Notes.
  • Option links.
  • Tags.
  • Tag links.

• Custom renderer support.

• Dynamic highlight groups.

• Hybrid mode for viewing & writing together.

• Splitview for side-by-side viewing of the file being edited.

• Help command wrappers(:Help, :H) to change where help is shown.

📚 Requirements

System,

• Neovim: 0.10.3

Colorscheme,

• Any tree-sitter based colorscheme is recommended.

External icon providers,

{
    preview = {
        icon_provider = "internal", -- "mini" or "devicons"
    }
}

• mini.icons
• nvim-web-devicons

Parsers,

:TSInstall vimdoc

• vimdoc

Fonts,

• Nerd fonts are recommended.

📐 Installation

🧩 Vim-plug

Add this to your plugin list.

Plug "OXY2DEV/helpview.nvim"

💤 Lazy.nvim

The plugin should be loaded after your colorscheme to ensure the correct highlight groups are used.

-- For `plugins/helpview.lua` users.
return {
    "OXY2DEV/helpview.nvim",
    lazy = false
};

-- For `plugins.lua` users.
{
    "OXY2DEV/helpview.nvim",
    lazy = false
},

🦠 Mini.deps

local MiniDeps = require("mini.deps");

MiniDeps.add({
    source = "OXY2DEV/helpview.nvim"
});

🌒 Rocks.nvim

:Rocks install helpview.nvim

📥 GitHub release

Tagged releases can be found in the release page.

🚨 Development version

You can use the dev branch to use test features.

return {
    "OXY2DEV/helpview.nvim",
    branch = "dev",
    lazy = false
};

🧭 Configuration

Check the wiki for the entire configuration table. A simplified version is given below.

--- Configuration for `helpview.nvim`.
---@class helpview.config
---
--- Preview options.
---@field preview? helpview.preview
---
--- Configuration options for vimdoc.
---@field vimdoc? helpview.vimdoc
---
--- Custom highlight groups.
---@field highlight_groups? table[]
---
--- Custom renderers
---@field renderers? { [string]: function }
{
	renderers = {},

	preview = {
		enable = true,
		enable_hybrid_mode = true,

		modes = { "n", "c", "no" },
		hybrid_modes = {},
		linewise_hybrid_mode = false,

		filetypes = { "help" },
		ignore_previews = {},
		ignore_buftypes = {},
		condition = nil,

		max_buf_lines = 500,
		draw_range = { 2 * vim.o.lines, 2 * vim.o.lines },
		edit_range = { 0, 0 },

		debounce = 150,
		callbacks = {},

		icon_provider = "internal",

		splitview_winopts = { split = "right" },
		preview_winopts = { width = math.floor(80) }
	},

    vimdoc = {
        arguments = {},
        code_blocks = {},
        headings = {},
        highlight_groups = {},
        horizontal_rules = {},
        inline_codes = {},
        keycodes = {},
        modelines = {},
        notes = {},
        optionlinks = {},
        tags = {},
        taglinks = {},
        urls = {}
    }
}

🎇 Commands

This plugin follows the sub-commands approach for creating commands. There is only a single :Helpview command.

It comes with the following sub-commands,

:Helpview toggle "Toggles preview of the current buffer.

🎨 Highlight groups

helpview.nvim creates a number of primary highlight groups that are used by most of the decorations.

If you want to create your own dynamic highlight groups or modify existing ones, see the custom highlight groups section.

The source highlight group's values are turned into Lab color-space and then mixed to reduce unwanted results.

These groups are then used as links by other groups responsible for various preview elements,

* = The color is converted to HSL and it's luminosity(L) is increased/decreased by the specified amount.

** = The background color of HelpviewCode is added to the groups.

*** = Linearly interpolated value between 2 highlight groups fg.

There are also highlight groups that are made using the default highlight groups