{"id":13961828,"url":"https://github.com/4513ECHO/vim-readme-viewer","last_synced_at":"2025-07-21T06:31:58.919Z","repository":{"id":43465645,"uuid":"432879377","full_name":"4513ECHO/vim-readme-viewer","owner":"4513ECHO","description":"📖 Viewing plugin's README easily like vim help","archived":false,"fork":false,"pushed_at":"2024-01-04T06:22:32.000Z","size":3319,"stargazers_count":28,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T17:51:33.481Z","etag":null,"topics":["ddu-source","ddu-vim","dein","neovim","neovim-plugin","vim","vim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/4513ECHO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-11-29T02:21:15.000Z","updated_at":"2025-03-18T14:43:33.000Z","dependencies_parsed_at":"2024-01-04T07:27:13.170Z","dependency_job_id":"415d5b11-f374-4f00-a956-4b758ace4636","html_url":"https://github.com/4513ECHO/vim-readme-viewer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/4513ECHO/vim-readme-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4513ECHO%2Fvim-readme-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4513ECHO%2Fvim-readme-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4513ECHO%2Fvim-readme-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4513ECHO%2Fvim-readme-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/4513ECHO","download_url":"https://codeload.github.com/4513ECHO/vim-readme-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/4513ECHO%2Fvim-readme-viewer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266253595,"owners_count":23900052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ddu-source","ddu-vim","dein","neovim","neovim-plugin","vim","vim-plugin"],"created_at":"2024-08-08T17:01:30.991Z","updated_at":"2025-07-21T06:31:53.900Z","avatar_url":"https://github.com/4513ECHO.png","language":"Vim Script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"# vim-readme-viewer\n\nPlease read [help](doc/readme_viewer.txt) for details.\n\n\u003e 📖 Viewing plugin's README easily like vim help\n\n![screenshot](img/screenshot.gif)\n\n\u003c!--ts--\u003e\n* [vim-readme-viewer](#vim-readme-viewer)\n   * [About](#about)\n   * [Why use this?](#why-use-this)\n   * [Features](#features)\n   * [Installation](#installation)\n      * [\u003ca href=\"https://github.com/Shougo/dein.vim\"\u003edein.vim\u003c/a\u003e](#deinvim)\n      * [\u003ca href=\"https://github.com/Shougo/dpp.vim\"\u003edpp.vim\u003c/a\u003e](#dppvim)\n      * [\u003ca href=\"https://github.com/junegunn/vim-plug\"\u003evim-plug\u003c/a\u003e](#vim-plug)\n      * [\u003ca href=\"https://github.com/k-takata/minpac\"\u003eminpac\u003c/a\u003e](#minpac)\n      * [\u003ca href=\"https://github.com/wbthomason/packer.nvim\"\u003epacker.nvim\u003c/a\u003e](#packernvim)\n      * [\u003ca href=\"https://github.com/tani/vim-jetpack\"\u003evim-jetpack\u003c/a\u003e](#vim-jetpack)\n   * [Tips](#tips)\n      * [General](#general)\n      * [vim-plug](#vim-plug-1)\n      * [packer.nvim](#packernvim-1)\n      * [ddu.vim](#dduvim)\n   * [TODO](#todo)\n   * [Introduced Articles](#introduced-articles)\n   * [License](#license)\n\u003c!--te--\u003e\n\nCreated by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)\n\n## About\n\nvim-readme-viewer help you to view some installed plugins' README(.md) file\neasily like vim help file. Viewing vim help file is very easy. Only\n`:help {topic}`! This plugin usage is also easy. If you are using\n[dein.vim](https://github.com/Shougo/dein.vim), please try:\n\n```vim\n:DeinReadme dein.vim\n:DeinReadme vim-readme-viewer\n\" ... and other plugins\n```\n\nIf you are using other plugin managers, please try:\n\n```vim\n:DppReadme vim-readme-viewer\n:PlugReadme vim-readme-viewer  \" for vim-plug\n:PackReadme vim-readme-viewer  \" for minpac\n:PackerReadme vim-readme-viewer  \" for packer.nvim\n:JetpackReadme vim-readme-viewer  \" for vim-jetpack\n\" ... and other plugins\n```\n\n## Why use this?\n\nVim help file is very useful and viewing it is very easy. However, some plugins,\nwhich is special such as colorschemes or tiny plugins, sometimes don't have vim\nhelp file. So, when you want to custom those plugins, you have to read README.md\nor look at plugins' inside code. It is not good for you because you have to do\nit outside vim.\n\n## Features\n\n- Support many plugin managers\n  - [dein.vim](https://github.com/Shougo/dein.vim)\n  - [dpp.vim](https://github.com/Shougo/dpp.vim)\n  - [vim-plug](https://github.com/junegunn/vim-plug)\n  - [minpac](https://github.com/k-takata/minpac)\n  - [packer.nvim](https://github.com/wbthomason/packer.nvim)\n  - [vim-jetpack](https://github.com/tani/vim-jetpack)\n- Include fuzzy finders source\n  - [ddu.vim](https://github.com/Shougo/ddu.vim) (**experimental** feature)\n\n## Installation\n\n### [dein.vim](https://github.com/Shougo/dein.vim)\n\nwith vim script:\n\n```vim\nlet g:readme_viewer#plugin_manager = 'dein.vim'\ncall dein#add('4513ECHO/vim-readme-viewer', {'on_cmd': 'DeinReadme'})\n```\n\nwith toml:\n\n```toml\n[[plugins]]\nrepo = '4513ECHO/vim-readme-viewer'\non_cmd = ['DeinReadme']\nhook_add = '''\nlet g:readme_viewer#plugin_manager = 'dein.vim'\n'''\n```\n\n### [dpp.vim](https://github.com/Shougo/dpp.vim)\n\nDepends on your liking configuration.\n\n### [vim-plug](https://github.com/junegunn/vim-plug)\n\n```vim\nlet g:readme_viewer#plugin_manager = 'vim-plug'\nPlug '4513ECHO/vim-readme-viewer', { 'on': 'PlugReadme' }\n```\n\n### [minpac](https://github.com/k-takata/minpac)\n\n```vim\nlet g:readme_viewer#plugin_manager = 'minpac'\ncall minpac#add('4513ECHO/vim-readme-viewer')\n```\n\n### [packer.nvim](https://github.com/wbthomason/packer.nvim)\n\n```lua\nuse {\n  '4513ECHO/vim-readme-viewer',\n  opt = true,\n  cmd = 'PackerReadme',\n  config = function()\n    vim.g['readme_viewer#plugin_manager'] = 'packer.nvim'\n  end\n}\n```\n\n### [vim-jetpack](https://github.com/tani/vim-jetpack)\n\n```vim\nlet g:readme_viewer#plugin_manager = 'vim-jetpack'\nJetpack '4513ECHO/vim-readme-viewer', { 'on': 'JetpackReadme' }\n```\n\n## Tips\n\n### General\n\nBasically vim-readme-viewer automatically judge your using plugin manager.\nHowever, it sometimes may fail. I recommend that you set manually\n`g:readme_viewer#plugin_manager` to plugin manager.\n\n```vim\nlet g:readme_viewer#plugin_manager = 'vim-plug'  \" for vim-plug\nlet g:readme_viewer#plugin_manager = 'minpac'  \" for minpac\n```\n\n### vim-plug\n\nOn default, vim-plug is not register itself as a plugin. So, vim-readme-viewer\ncannot open vim-plug's README.md. If you want to view vim-plug's README.md, you\nregister vim-plug as a plugin.\n\n```vim\nPlug 'junegunn/vim-plug'\n```\n\n### packer.nvim\n\n- `:PackerReadme` require that executing `:PackerCompile`. If you don't execute\n  it, `vim-readme-viewer` throws error.\n- plugin's path data is sometimes empty. See also\n  [wbthomason/packer.vim#765](https://github.com/wbthomason/packer.nvim/issues/765).\n\n### ddu.vim\n\nUsage examples:\n\n```vim\n\" Set kind default action\ncall ddu#custom#pathch_global({\n      \\ 'kindOptions': {\n      \\   'readme_viewer': {\n      \\     'defaultAction': 'open',\n      \\ }}})\n\" Use readme_viewer source.\ncall ddu#start({'sources': [{'name': 'readme_viewer'}]})\n```\n\n## TODO\n\n- Improve README.md and doc/readme_viewer.txt\n  - [ ] add new functions to doc/readme_viewer.txt\n- Support other plugin managers\n  - [ ] runtimepath based plugin manager\n  - [ ] buildin package system based plugin manager\n  - [x] [dein.vim](https://github.com/Shougo/dein.vim)\n  - [ ] [dpp.vim](https://github.com/Shougo/dpp.vim)\n  - [x] [vim-plug](https://github.com/junegunn/vim-plug)\n  - [x] [minpac](https://github.com/k-takata/minpac)\n  - [x] [packer.nvim](https://github.com/wbthomason/packer.nvim)\n\n## Introduced Articles\n\nIf you wrote an article about the plugin, please send me Pull-Request 😃\n\n- [インストールしたプラグインのREADME.mdをお手軽に見れるvim-readme-viewer作った](https://zenn.dev/4513echo/articles/2021-12-04-vim-readme-viewer)\n  (Japanese)\n- [vim-readme-viewerの対象をfzfで選択するコマンドを作った](https://zenn.dev/kawarimidoll/articles/316023e5b61d00)\n  (Japanese)\n\n## License\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4513ECHO%2Fvim-readme-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F4513ECHO%2Fvim-readme-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F4513ECHO%2Fvim-readme-viewer/lists"}