Download the PHP package voku/php-readme-helper without Composer
On this page you can find all versions of the php package voku/php-readme-helper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download voku/php-readme-helper
More information about voku/php-readme-helper
Files in voku/php-readme-helper
Download voku/php-readme-helper
More information about voku/php-readme-helper
Files in voku/php-readme-helper
Vendor voku
Package php-readme-helper
Short Description auto-generate your README from your code
License MIT
Homepage https://github.com/voku/Php-Readme-Helper
Package php-readme-helper
Short Description auto-generate your README from your code
License MIT
Homepage https://github.com/voku/Php-Readme-Helper
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
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.
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 PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- 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.
Please rate this library. Is it a good library?
Informations about the package php-readme-helper
📖 PHP README Helper
Helper to auto-generate the API documentation in your README file.
Example
(build/generate_docs.php)
GenerateApi
generate(string $codePath, string $baseDocFilePath, string[]|null $useClasses): string
↑ This method can generate API documentation with types from php code into your README file.
Parameters:
string $codePath <p>Path to a file or a directory.</p>string $baseDocFilePath <p>Path to your base file for the README.</p>array<array-key, string>|null $useClasses <p>If used, you can specify to classes, you will use.</p>
Return:
string <p>Return a string with the generated README.</p>
Support
For support and donations please visit Github | Issues | PayPal | Patreon.
For status updates and release announcements please visit Releases | Twitter | Patreon.
For professional support please contact me.
Thanks
- Thanks to GitHub (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
- Thanks to IntelliJ as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
- Thanks to Travis CI for being the most awesome, easiest continous integration tool out there!
- Thanks to StyleCI for the simple but powerfull code style check.
- Thanks to PHPStan && Psalm for really great Static analysis tools and for discover bugs in the code!
All versions of php-readme-helper with dependencies
PHP Build Version
Package Version
The package voku/php-readme-helper contains the following files
Loading the files please wait ....