Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ray-x/viewdoc.nvim
Search and view your (vim plugins) markdown & help files with glow
https://github.com/ray-x/viewdoc.nvim
glow markdown neovim neovim-plugin
Last synced: about 2 months ago
JSON representation
Search and view your (vim plugins) markdown & help files with glow
- Host: GitHub
- URL: https://github.com/ray-x/viewdoc.nvim
- Owner: ray-x
- License: agpl-3.0
- Created: 2021-12-11T11:23:48.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T02:00:32.000Z (about 2 years ago)
- Last Synced: 2024-05-11T00:36:00.199Z (4 months ago)
- Topics: glow, markdown, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 19.5 KB
- Stars: 20
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```vim
Plug 'ray-x/guihua.lua' "float term, gui support
Plug 'ray-x/go.nvim'
```
## Dependencies
- [fd](https://github.com/sharkdp/fd)
- [glow](https://github.com/charmbracelet/glow)
- [mdcat](https://codeberg.org/flausch/mdcat/) preview markdown with embedded image support
## setup
```lua
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
```lua
:Viewdoc sarama
```
- Check document in current project
```lua
:Viewdoc
```
## Screenshots
