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

1. Require this composer package "concrete/documentation_generator"
2. 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

1. Run composer install
2. Move the clone or symbolically link to your packages directory
3. 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

Generators