This is a custom template to use with phpDocumentor.
It is intended to create the code documentation as markdown files, fully compatible to serve as a GitHub Wiki in a GitHub repository of your choice.
You can find a live example in this GitHub repository: zorgch/zorg-code/wiki
- phpDocumentor must be installed or available using its
.phar - You have a GitHub Wiki cloned locally
- Download & unpack - or clone - this repository to your computer
- Specifiy this template
phpDocumentor-Template-ghwikiwhile generating your code documentation usingphpDocumentor:
php ./phpDocumentor.phar -d "/path/to/my/sourcecode" -t "/path/to/local/github-wiki" --template="/path/to/phpDocumentor-Template-ghwiki" --cache-folder "/path/to/store/cache" --title "My code project"
- NOTE: you may get an error at the end of the parsing - which you can just ignore, all work was done:
ERROR In PathGenerator.php line 120: Variable substitution in path /namespaces/{{name}}.md failed, variable "name" did not return a value
- The target directory
/github-wikiconsists of various markdown (.md) files now - Review, commit & push your local GitHub Wiki repository changes
- Browse to the Wiki on the corresponding GitHub repository to see your code documentation online
Consider that GitHub Wiki pages are in a flat file hierarchy. Fortunately you still can use folders in the repository itself - so you can have a clean structure in the Wiki repository, but when linking between files it must behave like all Wiki pages are in a single, flat hierarchy.
The output consists of the following files hierarchy:
As mentioned, due to GitHub Wiki pages behaving not within any hierarchy, linking between Wiki pages is done...
- by referencing the file name of the page
- leaving away the
.mdextension
So use class-MyClass to link to the file /wiki/classes/class-MyClass.md.
Or file-myconfigs.inc.php to link to the file /wiki/files/file-myconfigs.inc.php.md.