PHPackages                             mikehaertl/yii2-apidoc-vim - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mikehaertl/yii2-apidoc-vim

ActiveLibrary[Utility & Helpers](/categories/utility)

mikehaertl/yii2-apidoc-vim
==========================

Yii 2 apidoc as Vim helpfiles

2.0.33(6y ago)5463MITPHPCI failing

Since Oct 30Pushed 6y ago3 watchersCompare

[ Source](https://github.com/mikehaertl/yii2-apidoc-vim)[ Packagist](https://packagist.org/packages/mikehaertl/yii2-apidoc-vim)[ RSS](/packages/mikehaertl-yii2-apidoc-vim/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (9)Dependencies (19)Versions (38)Used By (0)

Yii 2 API docs for Vim
======================

[](#yii-2-api-docs-for-vim)

Installation
------------

[](#installation)

Add `mikehaertl/yii2-apidoc-vim` to your [Vundle](https://github.com/gmarik/vundle) configuration.

Alternatively you can download the files from [here](https://github.com/mikehaertl/yii2-apidoc-vim/tags), extract the package and move the `docs/` directory to your `~/.vim` directory.

If the help is not available after installation, you can try to issue this command in VIM:

```
:helptags ~/.vimrc/doc
```

How to use
----------

[](#how-to-use)

There is no configuration required for this plugin.

```
:help yii/web/Controller
```

You should note though, that we use a forward slash (`/`) instead of a backslash (`\`) as 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.

How to create the doc files
---------------------------

[](#how-to-create-the-doc-files)

> **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 source files:

```
./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 `vendor/`.

How to customize the created doc files
--------------------------------------

[](#how-to-customize-the-created-doc-files)

You can modify the view files in `src/templates/views` and adjust the render methods in `src/templates/ApiRenderer.php`.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~55 days

Recently: every ~24 days

Total

37

Last Release

2240d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ed4cc6f6e2a51bf286f02ad0def4ee6736be32aea75bfdcd43047696cec56869?d=identicon)[mike](/maintainers/mike)

---

Top Contributors

[![mikehaertl](https://avatars.githubusercontent.com/u/675062?v=4)](https://github.com/mikehaertl "mikehaertl (56 commits)")

---

Tags

yii2apidocvim

### Embed Badge

![Health badge](/badges/mikehaertl-yii2-apidoc-vim/health.svg)

```
[![Health](https://phpackages.com/badges/mikehaertl-yii2-apidoc-vim/health.svg)](https://phpackages.com/packages/mikehaertl-yii2-apidoc-vim)
```

###  Alternatives

[brussens/yii2-maintenance-mode

Maintenance mode component for Yii framework 2.x.x version.

78256.3k5](/packages/brussens-yii2-maintenance-mode)[richardfan1126/yii2-js-register

Yii2 widget to register JS into view

1357.2k7](/packages/richardfan1126-yii2-js-register)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)