Download the PHP package mikehaertl/yii2-apidoc-vim without Composer

On this page you can find all versions of the php package mikehaertl/yii2-apidoc-vim. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package yii2-apidoc-vim

Yii 2 API docs for Vim

Installation

Add 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 ~/.vim directory.

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

How to use

There is no configuration required for this plugin.

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

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:

Now you can run the apidocvim command to extract the docs in Vim format from any source files:

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

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

All versions of yii2-apidoc-vim with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mikehaertl/yii2-apidoc-vim contains the following files

Loading the files please wait ....