readme_viewer.txt

*readme-viewer.txt*	Viewing plugin's README(.md) easily like vim help

Author: Hibiki <mail@4513echo.dev>
License: MIT License
URL: https://github.com/4513ECHO/vim-readme-viewer
Last change: 2023 May 16

==============================================================================
CONTENTS					*readme-viewer-contents*

Introduction					|readme-viewer-introdution|
Interface					|readme-viewer-interface|
  Commands					|readme-viewer-commands|
  Functions					|readme-viewer-functions|
  Variables					|readme-viewer-variables|
  Autocommands					|readme-viewer-autocommands|
About						|readme-viewer-about|

==============================================================================
INTRODUCTION					*readme-viewer-introdution*

*readme-viewer* or *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

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

Note: 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 = 'dein.vim'  " for dein.vim
	let g:readme_viewer#plugin_manager = 'dpp.vim'  " for dpp.vim
	let g:readme_viewer#plugin_manager = 'vim-plug'  " for vim-plug
	let g:readme_viewer#plugin_manager = 'minpac'  " for minpac
	let g:readme_viewer#plugin_manager = 'packer.nvim'  " for packer.nvim
	let g:readme_viewer#plugin_manager = 'vim-jetpack'  " for vim-jetpack"

Note: 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'

Note: This plugin is working with |dein.vim|, |dpp|, |vim-plug|, |minpac|,
|jetpack| and |packer.nvim| now.

==============================================================================
INTERFACE					*readme-viewer-interface*

------------------------------------------------------------------------------
COMMANDS					*readme-viewer-commands*

:ReadmeOpen {plugin}				*:ReadmeOpen*
	Open {plugin}'s README file. The command detects plugin manager
	automatically.

:DeinReadme {plugin}				*:DeinReadme*
:DppReadme {plugin}				*:DppReadme*
:PlugReadme {plugin}				*:PlugReadme*
:PackReadme {plugin}				*:PackReadme*
:PackerReadme {plugin}				*:PackerReadme*
:JetpackReadme {plugin}				*:JetpackReadme*
	Open {plugin}'s README file. |g:readme_viewer#plugin_manager| defines
	the command you can use. Please see it.

:ReadmeHelp					*:ReadmeHelp*
	Open current buffer plugin on |:help|. It sometimes fails when the
	plugin doesn't have itself help file.

:ReadmeDir					*:ReadmeDir*
	Open. It is same as `:edit %:p:h` . It is useful when you use some
	filer plugins. (e.g. |netrw|)

------------------------------------------------------------------------------
FUNCTIONS					*readme-viewer-functions*

						*readme_viewer#dein#get()*
						*readme_viewer#dpp#get()*
						*readme_viewer#plug#get()*
						*readme_viewer#minpac#get()*
						*readme_viewer#jetpack#get()*
readme_viewer#{plugin-manager}#get([{plugin-name}])
	Get the plugin information dictionary. If you omit {plugin-name},
	vim-readme-viewer will return the all of plugins directory. Its key is
	the plugin name and its value is the plugin information dictionary.

readme_viewer#get([{plugin-name}])		*readme_viewer#get()*
	Get the plugin information dictionary. It is alias of current plugin
	manager's `get` function. Please see above.

						*readme_viewer#dein#open()*
						*readme_viewer#dpp#open()*
						*readme_viewer#plug#open()*
						*readme_viewer#minpac#open()*
						*readme_viewer#jetpack#open()*
readme_viewer#{plugin-manager}#open({plugin}, {mods})
	Open {plugin}'s README file. {mods} is command modifiers. (e.g.
	"vertical topleft")

readme_viewer#open({plugin}, {mods})		*readme_viewer#open()*
	Open {plugin}'s README file. {mods} is command modifiers. It is alias
	of current plugin manager's `open` function. Please see above.

						*readme_viewer#open_buffer()*
readme_viewer#open_buffer({path}, {name} [, {mods}])
	Open {plugin}'s README file. {mods} is command modifiers. (e.g.
	"vertical topleft") Difference from |readme_viewer#open()| is to
	handle error or not.

------------------------------------------------------------------------------
VARIABLES					*readme-viewer-variables*

g:readme_viewer#plugin_manager		*g:readme_viewer#plugin_manager*
			string (default: empty)
	Your using plugin manager. This variable controls command you can use.
	If you omit it, vim-readme-viewer automatically judge your using
	plugin manager. I recommend that you set it manually.
	value		command~
	"|dein.vim|"	|:DeinReadme|
	"|dpp|.vim"	|:DppReadme|
	"|vim-plug|"	|:PlugReadme|
	"|minpac|"	|:PackReadme|
	"|packer.nvim|"	|:PackerReadme|
	"|vim-jetpack|"	|:JetpackReadme|

b:readme_data					*b:readme_data*
			dict
	Information of current buffer plugin. It is useful to custom this
	plugin.

	key		value~
	path		plugin installed directory
			(e.g. `/home/user/.vim/plugged/vim-readme-viewer`)
	name		plugin name (e.g. `vim-readme-viewer`)
	normalized_name	normalized plugin name
			(e.g. `readme-viewer`, `dein`, `packer`)

g:readme_viewer#open_help_buffer	*g:reame_viewer#open_help_buffer*
			boolean (default: |v:true|)
	Configure README buffer's motion. If you don't set this variables,
	README buffer's 'buftype' is setted "help". Please see also
	|special-buffers|.

g:readme_viewer#no_mappings			*g:readme_viewer#no_mappings*
			boolean (default: |v:false|)
	Disable buffer local mappings when README is opened. If you don't set
	this variables, you can use `q` to close README window.

g:readme_viewer#no_buffer_commands	*g:readme_viewer#no_buffer_commands*
			boolean (default: |v:false|)
	Disable buffer local commands when README is opened. If you don't set
	this variables, you can use |:ReadmeHelp| and |:ReadmeDir|.

------------------------------------------------------------------------------
AUTOCOMMANDS					*readme-viewer-autocommands*

ReadmeOpen					*ReadmeOpen*
	Invoked when a README is opened. It is useful to configure some
	buffer local mappings and commands.

==============================================================================
ABOUT						*readme-viewer-about*

|vim-readme-viewer| is developed by Hibiki(4513ECHO) and licensed under the
MIT License. Visit the project page for the latest version:

	https://github.com/4513ECHO/vim-readme-viewer

==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen: