PHPackages                             budkit/docs - 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. budkit/docs

ActiveLibrary

budkit/docs
===========

Generates beautiful PHP documentation

06CSS

Since Oct 16Pushed 10y ago1 watchersCompare

[ Source](https://github.com/stonelab/budkit-docs)[ Packagist](https://packagist.org/packages/budkit/docs)[ RSS](/packages/budkit-docs/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

budkit/docs
===========

[](#budkitdocs)

The PHP documentation generator that uses your existing source code! Based on the awesome [Docco](http://jashkenas.github.com/docco/) Javascript documentation generator (but with improvements for PHP!). This package builds on the work by [xeoncross/pocco](http://github.com/xeoncross/pocco) . Differences between this and the former, is the use of a much more complete Token Reflection library (See [livingstone/reflector](http://github.com/livingstone/reflector)) to process source files, and [erusev/parsedown](http://github.com/erusev/parsedown) to process annotations. This means you can have add markdown to your PHP source code docblocks

\##Dependencies

- php >= 5.4.0
- [livingstone/reflector](http://github.com/livingstonef/reflector) : "\*"
- erusev/parsedown : "\*"

Example
-------

[](#example)

- The Budkit framework reference uses this library [budkit/framework API](http://budkit.github.io/budkit-framework/Budkit/Application/Instance.php.html)

Usage
-----

[](#usage)

First you need to install the library using [Composer](http://getcomposer.org/doc/00-intro.md#globally). Create a `composer.json` file in your documentation folder and type this:

```
{
    "minimum-stability": "dev",
    "repositories":[
       {"type": "git", "url": "https://github.com/livingstone/livingstone/reflector.git"},
       {"type": "git", "url": "https://github.com/budkit/budkit-docs.git"},
    ]
	"require": {
	    "livingstone/reflector":"*",
		"budkit/docs": "dev-master"
	}
}

```

After you have created a composer.json file you can install budkit/docs.

```
$ composer install

```

Next, create an index.php file in the directory where you intend to create/save the docs e.g in your package 'docs' folder.

```