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.

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:
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.
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?

Example code of voku/php-readme-helper

Informations about the package php-readme-helper

CI Codacy Badge Latest Stable Version Total Downloads License Donate to this project using Paypal Donate to this project using Patreon

📖 PHP README Helper

Helper to auto-generate the API documentation in your README file.

Example

(build/generate_docs.php)

Template placeholders

In your base markdown file, use the following placeholders:

Placeholder Description
%__functions_index__ClassName__% Renders an HTML table index of all public methods.
%__functions_list__ClassName__% Renders the full API documentation for all public methods.
%__properties_index__ClassName__% Renders an HTML table index of all public properties (optional).
%__properties_list__ClassName__% Renders the full documentation for all public properties (optional).
%__enum_cases__ClassName__% Renders all cases of a PHP enum (optional).

Replace ClassName with the fully-qualified class name using backslashes, e.g. voku\PhpReadmeHelper\GenerateApi.

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:

Return:

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

All versions of php-readme-helper with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
voku/simple-php-code-parser Version ^0.21
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package voku/php-readme-helper contains the following files

Loading the files please wait ...