MarkDownDocsManager

Extends \org\turbocommons\src\main\php\model\BaseStrictClass

MarkDownDocsManager class

package

Default

Methods

Contains functionalities to manage a lightweight documentation structure based on markdown .md files, using the standard file system as the docs storage.

__construct(string $rootPath) 

To publish documentation, the following folder structure must be used: $_rootPath/folder-1/subfolder-2/subfolder-n/text.md

Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Call Stack: 0.5616 2255328 1. {main}() C:\Users\vmware\git\TurboBuilder\TurboBuilder-Node\src\main\libs\phpDocumentor.phar:0 0.5616 2250568 2. require('phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/bin/phpdoc') C:\Users\vmware\git\TurboBuilder\TurboBuilder-Node\src\main\libs\phpDocumentor.phar:10 0.8424 10411664 3. phpDocumentor\Application->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/bin/phpdoc:23 0.8892 10560368 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Application.php:183 0.8892 10560368 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:126 0.8892 10560368 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:202 0.8892 10625904 7. phpDocumentor\Command\Project\RunCommand->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:855 0.8892 10631432 8. phpDocumentor\Command\Project\RunCommand->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Command/Command.php:266 2.2776 18130880 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Command/Project/RunCommand.php:275 2.2776 18133744 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Command/Command.php:266 2.4024 19167632 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206 2.4024 19167632 12. call_user_func_array:{phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59}() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59 2.4024 19167648 13. phpDocumentor\Transformer\Transformer->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59 2.4024 19175128 14. phpDocumentor\Transformer\Transformer->transformProject() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:141 2.9016 21806576 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:275 2.9016 21806736 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:312 3.8844 22812064 17. Twig_Environment->render() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116 3.8844 22822288 18. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->render() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Environment.php:362 3.8844 22838800 19. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->display() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:411 3.8844 22839928 20. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22839928 21. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.8844 22841464 22. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->display() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\535ee61975b0524dc0fc5e705878de1a63d38e1fcb71cd37aaebef404319246a.php:41 3.8844 22842160 23. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22842160 24. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.8844 22905232 25. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->displayBlock() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\da\da2e8d6574d2b4133cc60edd04d95073809672b07e64081ce7d8d785bacea9cb.php:78 3.8844 22905232 26. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->block_content() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:215 3.8844 22910064 27. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->display() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\535ee61975b0524dc0fc5e705878de1a63d38e1fcb71cd37aaebef404319246a.php:286 3.8844 22910440 28. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22910440 29. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.8844 22928216 30. twig_length_filter() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\5351173f89ac4c628a336f4414f6a40916768e44ffc2ec95e364707179a016df.php:88 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1275 Call Stack: 0.5616 2255328 1. {main}() C:\Users\vmware\git\TurboBuilder\TurboBuilder-Node\src\main\libs\phpDocumentor.phar:0 0.5616 2250568 2. require('phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/bin/phpdoc') C:\Users\vmware\git\TurboBuilder\TurboBuilder-Node\src\main\libs\phpDocumentor.phar:10 0.8424 10411664 3. phpDocumentor\Application->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/bin/phpdoc:23 0.8892 10560368 4. Cilex\Provider\Console\ContainerAwareApplication->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Application.php:183 0.8892 10560368 5. Cilex\Provider\Console\ContainerAwareApplication->doRun() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:126 0.8892 10560368 6. Cilex\Provider\Console\ContainerAwareApplication->doRunCommand() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:202 0.8892 10625904 7. phpDocumentor\Command\Project\RunCommand->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Application.php:855 0.8892 10631432 8. phpDocumentor\Command\Project\RunCommand->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Command/Command.php:266 2.2776 18130880 9. phpDocumentor\Transformer\Command\Project\TransformCommand->run() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Command/Project/RunCommand.php:275 2.2776 18133744 10. phpDocumentor\Transformer\Command\Project\TransformCommand->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/symfony/console/Command/Command.php:266 2.4024 19167632 11. phpDocumentor\Console\Output\Output->writeTimedLog() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Command/Project/TransformCommand.php:206 2.4024 19167632 12. call_user_func_array:{phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59}() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59 2.4024 19167648 13. phpDocumentor\Transformer\Transformer->execute() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Console/Output/Output.php:59 2.4024 19175128 14. phpDocumentor\Transformer\Transformer->transformProject() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:141 2.9016 21806576 15. phpDocumentor\Transformer\Transformer->applyTransformationToProject() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:275 2.9016 21806736 16. phpDocumentor\Plugin\Twig\Writer\Twig->transform() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Transformer/Transformer.php:312 3.8844 22812064 17. Twig_Environment->render() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/src/phpDocumentor/Plugin/Twig/Writer/Twig.php:116 3.8844 22822288 18. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->render() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Environment.php:362 3.8844 22838800 19. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->display() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:411 3.8844 22839928 20. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22839928 21. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.8844 22841464 22. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->display() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\535ee61975b0524dc0fc5e705878de1a63d38e1fcb71cd37aaebef404319246a.php:41 3.8844 22842160 23. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22842160 24. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.8844 22905232 25. __TwigTemplate_855574be406c76895f62440aa34df44b9bf436319d493a63930a9077a86d2e6f->displayBlock() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\da\da2e8d6574d2b4133cc60edd04d95073809672b07e64081ce7d8d785bacea9cb.php:78 3.8844 22905232 26. __TwigTemplate_802e83cc7cb08b88d69850c0d65e420860d5a887b910566c821f931883582436->block_content() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:215 3.8844 22910064 27. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->display() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\535ee61975b0524dc0fc5e705878de1a63d38e1fcb71cd37aaebef404319246a.php:286 3.8844 22910440 28. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->displayWithErrorHandling() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:403 3.8844 22910440 29. __TwigTemplate_37b8194ff506641dab01348ed7184bc86d3f97feb8ada6b27626c2eb87fe40c4->doDisplay() phar://C:/Users/vmware/git/TurboBuilder/TurboBuilder-Node/src/main/libs/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Template.php:432 3.9000 22928216 30. twig_length_filter() C:\Users\vmware\AppData\Local\Temp\phpdoc-twig-cache\53\5351173f89ac4c628a336f4414f6a40916768e44ffc2ec95e364707179a016df.php:88

Arguments

$rootPath

string

A full filesystem path to the root of the folder where the documentation structure is located.