{"id":28453851,"url":"https://github.com/concretecms/documentation_generator","last_synced_at":"2025-06-28T05:31:29.943Z","repository":{"id":36769479,"uuid":"41076187","full_name":"concretecms/documentation_generator","owner":"concretecms","description":"concrete5 composer package for generating documentation based on configuration","archived":false,"fork":false,"pushed_at":"2022-05-19T01:18:26.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-06T18:52:59.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/concretecms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-20T04:53:35.000Z","updated_at":"2022-05-19T01:18:29.000Z","dependencies_parsed_at":"2022-08-21T08:50:49.698Z","dependency_job_id":null,"html_url":"https://github.com/concretecms/documentation_generator","commit_stats":null,"previous_names":["concrete5/documentation_generator"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/concretecms/documentation_generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concretecms%2Fdocumentation_generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concretecms%2Fdocumentation_generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concretecms%2Fdocumentation_generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concretecms%2Fdocumentation_generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/concretecms","download_url":"https://codeload.github.com/concretecms/documentation_generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concretecms%2Fdocumentation_generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262381334,"owners_count":23302217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-06T18:39:59.717Z","updated_at":"2025-06-28T05:31:29.929Z","avatar_url":"https://github.com/concretecms.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/concrete5/documentation_generator/blob/master/LICENSE.md)\n[![](http://img.shields.io/packagist/v/concrete5/documentation_generator.svg?style=flat)](https://packagist.org/packages/concrete5/documentation_generator)\n[![](http://img.shields.io/packagist/dt/concrete5/documentation_generator.svg?style=flat)](https://packagist.org/packages/concrete5/documentation_generator)\n[![](http://img.shields.io/scrutinizer/g/concrete5/documentation_generator.svg?style=flat)](http://scrutinizer-ci.com/g/concrete5/documentation_generator/)\n\n# concrete5 documentation generator\nThis composer package adds commands to concrete5's command line utility that\ngenerate documentation based on the core configuration values.\n\n## Installation\n\n### Using composer\n1. Require this composer package `\"concrete/documentation_generator\"`\n2. Add the base service provider to your `application/config/app.php`\n    ```php\n    \u003c?php\n    // application/config/app.php\n\n    return array(\n        'providers' =\u003e array(\n            'documentation_generator' =\u003e \"\\\\Concrete\\\\DocumentationGenerator\\\\ServiceProvider\"\n        )\n    );\n    ```\n\n### Using concrete5 package system\n1. Run composer install\n2. Move the clone or symbolically link to your packages directory\n3. Navigate to the install page in your concrete5 dashboard and hit install\n\n## Usage\nFrom the root of your concrete5 directory, run `$ ./concrete/bin/concrete5 c5:docs:generate \u003e docs.md`\n\n## Generators\n\n Handle | Class | Command | Description\n --- | --- | --- | ---\n `asset_list` | `\\Concrete\\DocumentationGenerator\\Generator\\Asset\\AssetListGenerator` | c5:docs:asset_list:generate | Generates a list of core assets and asset groups\n `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\n `service_provider_list` | `\\Concrete\\DocumentationGenerator\\Generator\\ServiceProvider\\ServiceProviderListGenerator` | c5:docs:service_provider_list:generate | Generates a list of core service providers\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcretecms%2Fdocumentation_generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconcretecms%2Fdocumentation_generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcretecms%2Fdocumentation_generator/lists"}