concrete5 / documentation_generator

此包已废弃且不再维护。作者建议使用concretecms/documentation_generator包。

为添加生成文档命令的concrete5 composer包

1.0-beta3 2015-08-26 20:30 UTC

This package is auto-updated.

Last update: 2022-05-19 18:25:43 UTC


README

concrete5文档生成器

此composer包向concrete5的命令行工具添加命令,根据核心配置值生成文档。

安装

使用composer

  1. 需要此composer包 "concrete/documentation_generator"
  2. 将基本服务提供者添加到您的 application/config/app.php
    <?php
    // application/config/app.php
    
    return array(
        'providers' => array(
            'documentation_generator' => "\\Concrete\\DocumentationGenerator\\ServiceProvider"
        )
    );

使用concrete5包系统

  1. 运行composer install
  2. 将克隆或符号链接移动到您的包目录
  3. 导航到您的concrete5仪表板中的安装页面并点击安装

用法

从您的concrete5目录的根目录运行 $ ./concrete/bin/concrete5 c5:docs:generate > docs.md

生成器

处理 命令 描述
asset_list \Concrete\DocumentationGenerator\Generator\Asset\AssetListGenerator c5:docs:asset_list:generate 生成核心资源和资源组列表
config_group \Concrete\DocumentationGenerator\Generator\ConfigGroup\ConfigGroupListGenerator c5:docs:config_group:generate 生成包含配置项的配置组列表和表格
service_provider_list \Concrete\DocumentationGenerator\Generator\ServiceProvider\ServiceProviderListGenerator c5:docs:service_provider_list:generate 生成核心服务提供者列表