PHPackages t3docs/fluid-documentation-generator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. t3docs/fluid-documentation-generator ActiveLibrary[Utility & Helpers](/categories/utility) t3docs/fluid-documentation-generator ==================================== Generates automatic documentation in RST format based on Fluid ViewHelper source files 4.4.3(4mo ago)116.0k↑106.8%25LGPL-3.0-or-laterPHPPHP ^8.2CI passing Since Jul 24Pushed 3mo ago9 watchersCompare [ Source](https://github.com/TYPO3-Documentation/fluid-documentation-generator)[ Packagist](https://packagist.org/packages/t3docs/fluid-documentation-generator)[ RSS](/packages/t3docs-fluid-documentation-generator/feed)WikiDiscussions main Synced 2w ago READMEChangelog (10)Dependencies (18)Versions (14)Used By (5) Fluid Documentation Generator ============================= [](#fluid-documentation-generator) This package generates an automatic Fluid ViewHelper reference documentation in [RST format](https://en.wikipedia.org/wiki/ReStructuredText). The included CLI command is configured with json files. Based on this configuration, the following assets are generated: - a directory structure with RST files to navigate between namespaces, groups of ViewHelper as well as the ViewHelpers themselves - a json file which contains all relevant information about the Fluid namespace and its ViewHelpers The result can be rendered with [render-guides](https://github.com/TYPO3-Documentation/render-guides), which contains a special RST directive to interpret the generated JSON file. Installation ------------ [](#installation) This package needs to be installed **inside** a composer project that contains all ViewHelpers that should be documented. ``` composer req --dev t3docs/fluid-documentation-generator ``` Configuration and Usage ----------------------- [](#configuration-and-usage) The documentation assets will be generated by using the following CLI command: ``` vendor/bin/fluidDocumentation generate viewhelpers1_config.json viewhelpers2_config.json ... ``` 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](./src/Config.schema.json). A minimal configuration file could look like this: ``` { "name": "MyPackage", "namespaceAlias": "my", "targetNamespace": "http://typo3.org/ns/Vendor/MyPackage/ViewHelpers" } ``` 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: - fluidDocumentationOutput/ - MyPackage/ - Index.rst - MyViewHelper.rst - ... - Index.rst - MyPackage.json Examples -------- [](#examples) Generate ViewHelper reference for `dev-main` of [TYPO3 Core](https://github.com/typo3/typo3) with [config files](./config/typo3/): ``` git clone git@github.com:TYPO3/typo3.git composer install composer require --dev t3docs/fluid-documentation-generator composer exec fluidDocumentation generate vendor/t3docs/fluid-documentation-generator/config/typo3/* ``` Generate ViewHelper reference for `dev-main` of [Fluid Standalone](https://github.com/TYPO3/Fluid) with [config files](./config/fluidStandalone/): ``` git clone git@github.com:TYPO3/Fluid.git composer install composer require --dev t3docs/fluid-documentation-generator composer exec fluidDocumentation generate vendor/t3docs/fluid-documentation-generator/config/fluidStandalone/viewhelpers_fluid.json ``` ### Health Score 58 — FairBetter than 98% of packages Maintenance79 Regular maintenance activity Popularity28 Limited adoption so far Community31 Small or concentrated contributor base Maturity83 Battle-tested with a long release history Bus Factor1 Top contributor holds 52.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~234 days Recently: every ~144 days Total 13 Last Release 137d ago Major Versions 1.0.0 → 3.0.02024-05-09 3.0.x-dev → 4.0.02024-07-03 PHP version history (2 changes)1.0.0PHP ^7.1 3.0.0PHP ^8.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/ca4eee1e54bccd482945cd03a170a3dfa0c4672c32d0a565dc1228a905a06c27?d=identicon)[s2b](/maintainers/s2b) ![](https://www.gravatar.com/avatar/81befeeadfe6fa202167d64ce1e66410b8cab345edbb652376946e16ccb6a9af?d=identicon)[linawolf](/maintainers/linawolf) --- Top Contributors [![s2b](https://avatars.githubusercontent.com/u/458524?v=4)](https://github.com/s2b "s2b (66 commits)")[![linawolf](https://avatars.githubusercontent.com/u/48202465?v=4)](https://github.com/linawolf "linawolf (29 commits)")[![alexander-nitsche](https://avatars.githubusercontent.com/u/20297232?v=4)](https://github.com/alexander-nitsche "alexander-nitsche (10 commits)")[![lolli42](https://avatars.githubusercontent.com/u/2178068?v=4)](https://github.com/lolli42 "lolli42 (4 commits)")[![DanielSiepmann](https://avatars.githubusercontent.com/u/354250?v=4)](https://github.com/DanielSiepmann "DanielSiepmann (4 commits)")[![NamelessCoder](https://avatars.githubusercontent.com/u/2228052?v=4)](https://github.com/NamelessCoder "NamelessCoder (3 commits)")[![maddy2101](https://avatars.githubusercontent.com/u/1925287?v=4)](https://github.com/maddy2101 "maddy2101 (3 commits)")[![tomwarwick](https://avatars.githubusercontent.com/u/17770210?v=4)](https://github.com/tomwarwick "tomwarwick (3 commits)")[![Kanti](https://avatars.githubusercontent.com/u/471387?v=4)](https://github.com/Kanti "Kanti (1 commits)")[![andreaskienast](https://avatars.githubusercontent.com/u/1787983?v=4)](https://github.com/andreaskienast "andreaskienast (1 commits)")[![garvinhicking](https://avatars.githubusercontent.com/u/273326?v=4)](https://github.com/garvinhicking "garvinhicking (1 commits)")[![susannemoog](https://avatars.githubusercontent.com/u/321804?v=4)](https://github.com/susannemoog "susannemoog (1 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Code StylePHP CS Fixer Type Coverage Yes ### Embed Badge ![Health badge](/badges/t3docs-fluid-documentation-generator/health.svg) ``` [![Health](https://phpackages.com/badges/t3docs-fluid-documentation-generator/health.svg)](https://phpackages.com/packages/t3docs-fluid-documentation-generator) ``` ### Alternatives [composer/composer Composer helps you declare, manage and install dependencies of PHP projects. It ensures you have the right stack everywhere. 29.5k199.6M3.4k](/packages/composer-composer)[paycore/openfintech-data Openfintech data 22310.1k](/packages/paycore-openfintech-data)[infection/infection Infection is a Mutation Testing framework for PHP. The mutation adequacy score can be used to measure the effectiveness of a test set in terms of its ability to detect faults. 2.2k30.0M2.9k](/packages/infection-infection)[ergebnis/composer-normalize Provides a composer plugin for normalizing composer.json. 1.1k43.3M3.4k](/packages/ergebnis-composer-normalize)[oat-sa/tao-core TAO core extension 64147.9k151](/packages/oat-sa-tao-core)[wikimedia/parsoid Parsoid, a bidirectional parser between wikitext and HTML5 200569.1k3](/packages/wikimedia-parsoid) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)