Download the PHP package t3docs/fluid-documentation-generator without Composer

On this page you can find all versions of the php package t3docs/fluid-documentation-generator. 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?

Informations about the package fluid-documentation-generator

Fluid Documentation Generator

This package generates an automatic [Fluid]() ViewHelper reference documentation in RST format. The included CLI command is configured with json files. Based on this configuration, the following assets are generated:

The result can be rendered with render-guides, which contains a special RST directive to interpret the generated JSON file.

Installation

This package needs to be installed inside a composer project that contains all ViewHelpers that should be documented.

Configuration and Usage

The documentation assets will be generated by using the following CLI command:

You can specify 1-n config files, separated by a space character. If you specify multiple files, their order is important because it will determine the order on the documentation's index page. You can use wildcards as well, see examples below.

Each configuration file must respect the provided JSON schema. A minimal configuration file could look like this:

The resulting JSON file will contain all ViewHelpers in the PHP namespace Vendor\MyPackage\ViewHelpers. The result will be placed in a folder called fluidDocumentationOutput. The output folder can be changed by providing the environment variable FLUID_DOCUMENTATION_OUTPUT_DIR. In the example, the folder structure will look like this:

Examples

Generate ViewHelper reference for dev-main of TYPO3 Core with config files:

Generate ViewHelper reference for dev-main of Fluid Standalone with config files:

All versions of fluid-documentation-generator with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-json Version *
justinrainbow/json-schema Version ^5.2
typo3fluid/fluid Version ^2.12 || ^4.0 || dev-main
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 t3docs/fluid-documentation-generator contains the following files

Loading the files please wait ....