concretecms / documentation_generator
Concrete composer package for adding commands that generate documentation.
1.0-beta3
2015-08-26 20:30 UTC
Requires
Requires (Dev)
- concrete5/concrete5: dev-develop
- phpunit/phpunit: ~4.8
This package is auto-updated.
Last update: 2024-10-19 06:18:58 UTC
README
concrete5 documentation generator
This composer package adds commands to concrete5's command line utility that generate documentation based on the core configuration values.
Installation
Using composer
- Require this composer package
"concrete/documentation_generator"
- Add the base service provider to your
application/config/app.php
<?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