Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4513ECHO/vim-readme-viewer
📖 Viewing plugin's README easily like vim help
https://github.com/4513ECHO/vim-readme-viewer
ddu-source ddu-vim dein neovim neovim-plugin vim vim-plugin
Last synced: 24 days ago
JSON representation
📖 Viewing plugin's README easily like vim help
- Host: GitHub
- URL: https://github.com/4513ECHO/vim-readme-viewer
- Owner: 4513ECHO
- License: mit
- Created: 2021-11-29T02:21:15.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T06:22:32.000Z (12 months ago)
- Last Synced: 2024-08-08T17:16:35.754Z (5 months ago)
- Topics: ddu-source, ddu-vim, dein, neovim, neovim-plugin, vim, vim-plugin
- Language: Vim Script
- Homepage:
- Size: 3.17 MB
- Stars: 29
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vim-readme-viewer
Please read [help](doc/readme_viewer.txt) for details.
> 📖 Viewing plugin's README easily like vim help
* [vim-readme-viewer](#vim-readme-viewer)
* [About](#about)
* [Why use this?](#why-use-this)
* [Features](#features)
* [Installation](#installation)
* [dein.vim](#deinvim)
* [dpp.vim](#dppvim)
* [vim-plug](#vim-plug)
* [minpac](#minpac)
* [packer.nvim](#packernvim)
* [vim-jetpack](#vim-jetpack)
* [Tips](#tips)
* [General](#general)
* [vim-plug](#vim-plug-1)
* [packer.nvim](#packernvim-1)
* [ddu.vim](#dduvim)
* [TODO](#todo)
* [Introduced Articles](#introduced-articles)
* [License](#license)
Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
## About
vim-readme-viewer help you to view some installed plugins' README(.md) file
easily like vim help file. Viewing vim help file is very easy. Only
`:help {topic}`! This plugin usage is also easy. If you are using
[dein.vim](https://github.com/Shougo/dein.vim), please try:
```vim
:DeinReadme dein.vim
:DeinReadme vim-readme-viewer
" ... and other plugins
```
If you are using other plugin managers, please try:
```vim
:DppReadme vim-readme-viewer
:PlugReadme vim-readme-viewer " for vim-plug
:PackReadme vim-readme-viewer " for minpac
:PackerReadme vim-readme-viewer " for packer.nvim
:JetpackReadme vim-readme-viewer " for vim-jetpack
" ... and other plugins
```
## Why use this?
Vim help file is very useful and viewing it is very easy. However, some plugins,
which is special such as colorschemes or tiny plugins, sometimes don't have vim
help file. So, when you want to custom those plugins, you have to read README.md
or look at plugins' inside code. It is not good for you because you have to do
it outside vim.
## Features
- Support many plugin managers
- [dein.vim](https://github.com/Shougo/dein.vim)
- [dpp.vim](https://github.com/Shougo/dpp.vim)
- [vim-plug](https://github.com/junegunn/vim-plug)
- [minpac](https://github.com/k-takata/minpac)
- [packer.nvim](https://github.com/wbthomason/packer.nvim)
- [vim-jetpack](https://github.com/tani/vim-jetpack)
- Include fuzzy finders source
- [ddu.vim](https://github.com/Shougo/ddu.vim) (**experimental** feature)
## Installation
### [dein.vim](https://github.com/Shougo/dein.vim)
with vim script:
```vim
let g:readme_viewer#plugin_manager = 'dein.vim'
call dein#add('4513ECHO/vim-readme-viewer', {'on_cmd': 'DeinReadme'})
```
with toml:
```toml
[[plugins]]
repo = '4513ECHO/vim-readme-viewer'
on_cmd = ['DeinReadme']
hook_add = '''
let g:readme_viewer#plugin_manager = 'dein.vim'
'''
```
### [dpp.vim](https://github.com/Shougo/dpp.vim)
Depends on your liking configuration.
### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
let g:readme_viewer#plugin_manager = 'vim-plug'
Plug '4513ECHO/vim-readme-viewer', { 'on': 'PlugReadme' }
```
### [minpac](https://github.com/k-takata/minpac)
```vim
let g:readme_viewer#plugin_manager = 'minpac'
call minpac#add('4513ECHO/vim-readme-viewer')
```
### [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
'4513ECHO/vim-readme-viewer',
opt = true,
cmd = 'PackerReadme',
config = function()
vim.g['readme_viewer#plugin_manager'] = 'packer.nvim'
end
}
```
### [vim-jetpack](https://github.com/tani/vim-jetpack)
```vim
let g:readme_viewer#plugin_manager = 'vim-jetpack'
Jetpack '4513ECHO/vim-readme-viewer', { 'on': 'JetpackReadme' }
```
## Tips
### General
Basically vim-readme-viewer automatically judge your using plugin manager.
However, it sometimes may fail. I recommend that you set manually
`g:readme_viewer#plugin_manager` to plugin manager.
```vim
let g:readme_viewer#plugin_manager = 'vim-plug' " for vim-plug
let g:readme_viewer#plugin_manager = 'minpac' " for minpac
```
### vim-plug
On default, vim-plug is not register itself as a plugin. So, vim-readme-viewer
cannot open vim-plug's README.md. If you want to view vim-plug's README.md, you
register vim-plug as a plugin.
```vim
Plug 'junegunn/vim-plug'
```
### packer.nvim
- `:PackerReadme` require that executing `:PackerCompile`. If you don't execute
it, `vim-readme-viewer` throws error.
- plugin's path data is sometimes empty. See also
[wbthomason/packer.vim#765](https://github.com/wbthomason/packer.nvim/issues/765).
### ddu.vim
Usage examples:
```vim
" Set kind default action
call ddu#custom#pathch_global({
\ 'kindOptions': {
\ 'readme_viewer': {
\ 'defaultAction': 'open',
\ }}})
" Use readme_viewer source.
call ddu#start({'sources': [{'name': 'readme_viewer'}]})
```
## TODO
- Improve README.md and doc/readme_viewer.txt
- [ ] add new functions to doc/readme_viewer.txt
- Support other plugin managers
- [ ] runtimepath based plugin manager
- [ ] buildin package system based plugin manager
- [x] [dein.vim](https://github.com/Shougo/dein.vim)
- [ ] [dpp.vim](https://github.com/Shougo/dpp.vim)
- [x] [vim-plug](https://github.com/junegunn/vim-plug)
- [x] [minpac](https://github.com/k-takata/minpac)
- [x] [packer.nvim](https://github.com/wbthomason/packer.nvim)
## Introduced Articles
If you wrote an article about the plugin, please send me Pull-Request 😃
- [インストールしたプラグインのREADME.mdをお手軽に見れるvim-readme-viewer作った](https://zenn.dev/4513echo/articles/2021-12-04-vim-readme-viewer)
(Japanese)
- [vim-readme-viewerの対象をfzfで選択するコマンドを作った](https://zenn.dev/kawarimidoll/articles/316023e5b61d00)
(Japanese)
## License
MIT License