Yii 2 apidoc as Vim helpfiles
mikehaertl/yii2-apidoc-vim to your Vundle configuration.
Alternatively you can download the files from here,
extract the package and move the
docs/ directory to your
If the help is not available after installation, you can try to issue this command in VIM:
There is no configuration required for this plugin.
You should note though, that we use a forward slash (
/) instead of a backslash (
namespace separator. This was neccessary because when searching for tags, Vim uses regular
expressions. So any backslash would indicate the start of a search pattern and you would
have to type e.g.
yii\\base\\Controller. Autocomplete wouldn't work very well either.
Note: This is only required if want to build your own flavour of the help files.
Start in an empty directory and install the
yii2-apidoc-vim package via composer:
composer require mikehaertl\yii2-apidoc-vim dev-master
Now you can run the
apidocvim command to extract the docs in Vim format from any
./apidocvim api path/to/some/source/code /path/to/output/dir
You can also use the
update-all command to automatically extract the doc files from
the currenty yii2 packages installed in
You can modify the view files in
src/templates/views and adjust the render methods in