liamfiddler / phpdoc-to-githubwiki

Bash script to pull a GitHub repo, run PHPDoc, output the documentation as Markdown files, then push the documentation back to GitHub as a Wiki.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PHPDoc to GitHub Wiki

Bash script to pull a GitHub repo, run PHPDoc, output the documentation as Markdown files, then push the documentation back to GitHub as a Wiki.

How to Run

  1. Open Terminal
  2. Run phpdoc-to-githubwiki.sh

Requirements

  • Composer
  • Git
  • PHPDocumentor

About

Bash script to pull a GitHub repo, run PHPDoc, output the documentation as Markdown files, then push the documentation back to GitHub as a Wiki.


Languages

Language:Shell 80.4%Language:PHP 19.6%