File: README.md

Recommend this page to a friend!
  Classes of Stefan Kientzler  >  PHPDoc 2 Github Wiki  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHPDoc 2 Github Wiki
Generate documentation for packages in GitHub
Author: By
Last change: Update README.md
Date: 2 months ago
Size: 2,337 bytes
 

Contents

Class file image Download

Builder and Template to create a github wiki with phpDocumentor 3

Latest Stable Version Donate Minimum PHP Version

Overview

This package contains a PHP CLI script and the needed template to create the class reference for your PHP repository in the format for a github wiki using phpDocumentor 3.

GitHub wiki provides an easy-to-use tool for creating a documentation. With this package, the work of adding a complete class reference to this documentation is automated with the help of phpDocumentor.

Usage

  1. The easiest way is to make the githubwiki.phar available on the system and configure your project. (read the section 'Create the githubwiki.phar' at the end of this document for more information)
  2. For more control over the creation steps, the template can be used directly with phpDocumentor and the publication on github can be done with git and/or github-dektop. A corresponding bash script is included in the package for this purpose.

The use and configuration of both methods is explained in detail in the blog that was published for this package.

Donation

If you like githubwiki please consider donating at Paypal

Acknowledgments

  • The builder makes use of the package CLICommander from phpClasses.org contributed by Don Bauer (lordgnu@me.com).
  • Thanks to Théo FIDRY for contributing the box project to easy-create PHAR's

Create the githubwiki.phar

The githubwiki.phar can be easily created using the box builder:

  1. Download latest version from the github repository.
  2. Make it available on your system:

    sudo mv box.phar /usr/local/bin/box
    sudo chmod +x /usr/local/bin/box
    
  3. change to the base directory of this package
  4. call the box builder

    box build -v
    
  5. The created `githubwiki.phar` can be found in the `bin` directory.
For more information send a message to info at phpclasses dot org.