Download the PHP package fr3nch13/phpdoc-markdown without Composer
On this page you can find all versions of the php package fr3nch13/phpdoc-markdown. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fr3nch13/phpdoc-markdown
More information about fr3nch13/phpdoc-markdown
Files in fr3nch13/phpdoc-markdown
Package phpdoc-markdown
Short Description phpDocumentor template that generates Markdown documentation.
License MIT
Homepage https://dfir-bedlam.ocio.nih.gov/fr3nch13/phpdoc-markdown
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phpdoc-markdown
Archived.
I'm archiving this project, but I'll keep it up if anyone wants to fork it. The last time I tried ig with phpdoc was version 2.9.0, so I'm pretty sure it will no longer with with version 3.x
phpDocumentor markdown template
phpDocumentor template that generates Markdown documentation.
This is basically a markdown version of phpDocumentor's Clean template.
The main use-case for this template is to generate simple and nice looking usage documentation, that can then be published on GitHub/GitLab.
For example, a small library can document it's public API in DocBlock comments, use this template to generate the Markdown documentation and then commit it to GitHub with the library to easily create a nice looking documentation for other developers to see.
Installation
Install with composer:
Usage
Run phpDocumentor and set template as vendor/fr3nch13/phpdoc-markdown/data/templates/markdown.
This requires the usage of the phpdoc.xml file as phpDocumentor only generates html files, and they need to be changed to md files, and the links in the generated templates need to be modified.
This is done using a php script in the bin/directory that uses the phpdoc.xml file to know where the generated templates are located.
Example using configuration file:
Add a file called phpdoc.xml with the following content to the root of your project and invoke the phpdoc command without arguments. Modify the configuration to suit your project.
After you've created the phpdoc.xml, you can now run phpdoc without arguments, then run the php script to fix the generated files.
Or, you can add it to your composer.json scripts section, this is how I do it.
Then run:
More information about configuring phpDocumentor.
