PHP Classes

PHPDoc 2 Github Wiki: Generate documentation for packages in GitHub

Recommend this page to a friend!
  Info   View files Documentation   View files View files (28)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog (2)    
Last Updated Ratings Unique User Downloads Download Rankings
2021-08-02 (4 months ago) RSS 2.0 feedNot enough user ratingsTotal: 33 All time: 10,328 This week: 192Up
Version License PHP version Categories
phpdoc2githubwiki 1.0.0GNU General Publi...7Utilities and Tools, Language, PHP 7
Description Author

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.

Innovation Award
PHP Programming Innovation award nominee
July 2021
Number 5
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.

Manuel Lemos
Picture of Stefan Kientzler
  Performance   Level  
Name: Stefan Kientzler is available for providing paid consulting. Contact Stefan Kientzler .
Classes: 16 packages by
Country: Germany Germany
Age: 54
All time rank: 113674 in Germany Germany
Week rank: 14 Up1 in Germany Germany Up
Innovation award
Innovation award
Nominee: 9x

Winner: 6x

Details

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.
  Files folder image Files  
File Role Description
Files folder imagebash (2 files)
Files folder imagebin (1 file)
Files folder imagelordgnu (1 directory)
Files folder imageSKien (2 directories)
Files folder imagetemplate (10 files)
Accessible without login Plain text file autoloader.php Aux. Auxiliary script
Accessible without login Plain text file box.json Data Auxiliary data
Accessible without login Plain text file githubwiki-help.txt Doc. Documentation
Accessible without login Plain text file githubwiki.php Example Example script
Accessible without login Plain text file githubwiki.xml Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpdoc.template.xml Data Auxiliary data
Accessible without login Plain text file phpstan.neon Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  bash  
File Role Description
  Accessible without login Plain text file githubwiki Data Auxiliary data
  Accessible without login Plain text file phpdoc.xml Data Auxiliary data

  Files folder image Files  /  bin  
File Role Description
  Accessible without login Plain text file githubwiki.bat Data Auxiliary data

  Files folder image Files  /  lordgnu  
File Role Description
Files folder imageCLICommander (1 file)

  Files folder image Files  /  lordgnu  /  CLICommander  
File Role Description
  Plain text file CLICommander.php Class Class source

  Files folder image Files  /  SKien  
File Role Description
Files folder imageConfig (4 files)
Files folder imageGitHubWiki (1 file)

  Files folder image Files  /  SKien  /  Config  
File Role Description
  Plain text file AbstractConfig.php Class Class source
  Plain text file ConfigInterface.php Class Class source
  Plain text file NullConfig.php Class Class source
  Plain text file XMLConfig.php Class Class source

  Files folder image Files  /  SKien  /  GitHubWiki  
File Role Description
  Plain text file GitHubWikiCreator.php Class Class source

  Files folder image Files  /  template  
File Role Description
  Accessible without login Plain text file class-trait-ifc.md.twig Data Auxiliary data
  Accessible without login Plain text file class.md.twig Data Auxiliary data
  Accessible without login Plain text file footer.md.twig Data Auxiliary data
  Accessible without login Plain text file github_wiki.twig Data Auxiliary data
  Accessible without login Plain text file index.md.twig Data Auxiliary data
  Accessible without login Plain text file interface.md.twig Data Auxiliary data
  Accessible without login Plain text file method.md.twig Data Auxiliary data
  Accessible without login Plain text file sidebar.md.twig Data Auxiliary data
  Accessible without login Plain text file template.xml Data Auxiliary data
  Accessible without login Plain text file trait.md.twig Data Auxiliary data

 Version Control Unique User Downloads Download Rankings  
 100%
Total:33
This week:0
All time:10,328
This week:192Up
User Comments (1)
Thats a very nice class, congratulations ;-)
3 months ago (José Filipe Lopes Santos)
80%StarStarStarStarStar
 
For more information send a message to info at phpclasses dot org.