library documentation_generator
concrete5 composer package for adding commands that generate documentation.
concrete5/documentation_generator
concrete5 composer package for adding commands that generate documentation.
- Wednesday, August 26, 2015
- by KorvinSzanto
- Repository
- 4 Watchers
- 0 Stars
- 12,435 Installations
- PHP
- 0 Dependents
- 0 Suggesters
- 0 Forks
- 0 Open issues
- 8 Versions
- 5 % Grown
, (*1)
concrete5 documentation generator
This composer package adds commands to concrete5's command line utility that
generate documentation based on the core configuration values., (*2)
Installation
Using composer
- Require this composer package
"concrete/documentation_generator"
-
Add the base service provider to your application/config/app.php, (*3)
<?php
// application/config/app.php
return array(
'providers' => array(
'documentation_generator' => "\\Concrete\\DocumentationGenerator\\ServiceProvider"
)
);
Using concrete5 package system
- Run composer install
- Move the clone or symbolically link to your packages directory
- Navigate to the install page in your concrete5 dashboard and hit install
Usage
From the root of your concrete5 directory, run $ ./concrete/bin/concrete5 c5:docs:generate > docs.md, (*4)
Generators
| Handle |
Class |
Command |
Description |
asset_list |
\Concrete\DocumentationGenerator\Generator\Asset\AssetListGenerator |
c5:docs:asset_list:generate |
Generates a list of core assets and asset groups |
config_group |
\Concrete\DocumentationGenerator\Generator\ConfigGroup\ConfigGroupListGenerator |
c5:docs:config_group:generate |
Generates a list of core configuration groups with a table of the configuration items they contain |
service_provider_list |
\Concrete\DocumentationGenerator\Generator\ServiceProvider\ServiceProviderListGenerator |
c5:docs:service_provider_list:generate |
Generates a list of core service providers |
dev-master
9999999-dev
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
The Development Requires
1.0-beta3
1.0.0.0-beta3
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
The Development Requires
1.0-beta2
1.0.0.0-beta2
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
1.0-beta1
1.0.0.0-beta1
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
1.0-alpha4
1.0.0.0-alpha4
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
1.0-alpha3
1.0.0.0-alpha3
concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
1.0-alpha2
1.0.0.0-alpha2
Concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
1.0-alpha
1.0.0.0-alpha
Concrete5 composer package for adding commands that generate documentation.
Sources
Download
MIT
The Requires
Wallogit.com
