ray-x / viewdoc.nvim

Search and view your (vim plugins) markdown & help files with glow

Viewdoc

Flexible viewer for any documentation source (help/man/markdow/etc.). Search and filter inside Vim runtime path (vim plugins) or pre-configured paths. You can preview the documents with nvim and view the selected document with glow or mdcat(with embedded image support) in floating window

Install

Plug 'ray-x/guihua.lua' "float term, gui support

Plug 'ray-x/go.nvim'

Dependencies

• fd
• glow
• mdcat preview markdown with embedded image support

setup

require 'viewdoc'.setup({
  paths = {'myproject_path1', 'myproject_path2'}
    md_viewer = 'glow', -- or 'mdcat'
})

usage

• Check gitsigns document

:Viewdoc gitsigns

• Check sarama (a go kafka) document

:Viewdoc sarama

• Check document in current project

:Viewdoc

Screenshots