vim-readme-viewer

Please read help for details.

📖 Viewing plugin's README easily like vim help

• vim-readme-viewer
  • About
  • Why use this?
  • Features
  • Installation
    • dein.vim
    • vim-plug
    • minpac
    • packer.nvim
    • vim-jetpack
  • Tips
    • General
    • vim-plug
    • packer.nvim
    • ddu.vim
  • TODO
  • Introduced Articles
  • License

Created by gh-md-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, please try:

:DeinReadme dein.vim
:DeinReadme vim-readme-viewer
" ... and other plugins

If you are using other plugin managers, please try:

: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
  • vim-plug
  • minpac
  • packer.nvim
  • vim-jetpack
• Include fuzzy finders source
  • ddu.vim (experimental feature)

Installation

dein.vim

with vim script:

let g:readme_viewer#plugin_manager = 'dein.vim'
call dein#add('4513ECHO/vim-readme-viewer', {'on_cmd': 'DeinReadme'})

with toml:

[[plugins]]
repo = '4513ECHO/vim-readme-viewer'
on_cmd = ['DeinReadme']
hook_add = '''
let g:readme_viewer#plugin_manager = 'dein.vim'
'''

vim-plug

let g:readme_viewer#plugin_manager = 'vim-plug'
Plug '4513ECHO/vim-readme-viewer', { 'on': 'PlugReadme' }

minpac

let g:readme_viewer#plugin_manager = 'minpac'
call minpac#add('4513ECHO/vim-readme-viewer')

packer.nvim

use {
  '4513ECHO/vim-readme-viewer',
  opt = true,
  cmd = 'PackerReadme',
  config = function()
    vim.g['readme_viewer#plugin_manager'] = 'packer.nvim'
  end
}

vim-jetpack

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.

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.

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.

ddu.vim

Usage examples:

" 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
  • dein.vim
  • vim-plug
  • minpac
  • packer.nvim

Introduced Articles

If you wrote an article about the plugin, please send me Pull-Request 😃

• インストールしたプラグインのREADME.mdをお手軽に見れるvim-readme-viewer作った (Japanese)
• vim-readme-viewerの対象をfzfで選択するコマンドを作った (Japanese)

License

MIT License