README

本包生成自动的Fluid ViewHelper参考文档，格式为RST。包含的CLI命令通过json文件进行配置。基于此配置，生成以下资产

带有RST文件的目录结构，用于在命名空间、ViewHelper组以及ViewHelper自身之间导航
包含关于Fluid命名空间及其ViewHelper的所有相关信息的json文件

结果可以用render-guides渲染，其中包含解释生成的JSON文件的特殊RST指令。

安装

此包需要在包含所有应进行文档化的ViewHelper的composer项目中安装

composer req --dev t3docs/fluid-documentation-generator

配置和用法

使用以下CLI命令生成文档资产

vendor/bin/fluidDocumentation generate viewhelpers1_config.json viewhelpers2_config.json ...

您可以通过空格字符分隔指定1-n个配置文件。如果您指定多个文件，它们的顺序很重要，因为它将决定文档索引页上的顺序。您也可以使用通配符，以下为示例。

每个配置文件必须遵守提供的JSON模式。一个最小的配置文件可能如下所示

{
    "name": "MyPackage",
    "namespaceAlias": "my",
    "targetNamespace": "http://typo3.org/ns/Vendor/MyPackage/ViewHelpers"
}

生成的JSON文件将包含PHP命名空间Vendor\MyPackage\ViewHelpers中的所有ViewHelper。结果将放置在名为fluidDocumentationOutput的文件夹中。输出文件夹可以通过提供环境变量FLUID_DOCUMENTATION_OUTPUT_DIR进行更改。在示例中，文件夹结构将如下所示

fluidDocumentationOutput/
- MyPackage/
  - Index.rst
  - MyViewHelper.rst
  - ...
- Index.rst
- MyPackage.json

示例

使用配置文件生成TYPO3核心的dev-main的ViewHelper参考

git clone [email protected]:TYPO3/typo3.git
composer install
composer require --dev t3docs/fluid-documentation-generator
composer exec fluidDocumentation generate vendor/t3docs/fluid-documentation-generator/config/typo3/*

使用配置文件生成Fluid Standalone的dev-main的ViewHelper参考

git clone [email protected]: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

t3docs / fluid-documentation-generator

维护者

详细信息

README

安装

配置和用法

示例