|Ratings|| ||Unique User Downloads|| ||Download Rankings|
|Not enough user ratings||Total: 38 ||All time: 10,740 This week: 148|
This package can generate documentation for packages in GitHub.
It uses phpDocumentor to extract documentation from the source files of the package.
The package then sends documentation in Markdown format to be stored in files hosted by GitHub.
|Github is a popular site for hosting the revisions of files of projects of many developers.
Many PHP developers have already written nice documentation inside the source files of projects that are hosted in Github.
Github can render and display documentation in Markdown format.
This package can extract documentation from PHP projects hosted in Github and generates documentation in Markdown format using phpDocumentor. Then it pushes the generated documentation files to Github to be viewed as a Web page.
Builder and Template to create a github wiki with phpDocumentor 3
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.
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)
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.
If you like githubwiki please consider donating at Paypal
The builder makes use of the package CLICommander from phpClasses.org contributed by Don Bauer (firstname.lastname@example.org).
Thanks to Théo FIDRY for contributing the box project to easy-create PHAR's
Create the githubwiki.phar
githubwiki.phar can be easily created using the box builder:
Download latest version from the github repository.
Make it available on your system:
sudo mv box.phar /usr/local/bin/box
sudo chmod +x /usr/local/bin/box
change to the base directory of this package
call the box builder
box build -v
The created `githubwiki.phar` can be found in the `bin` directory.
||Applications that use this package
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.