{"id":36372581,"url":"https://github.com/gobst/buildadoc","last_synced_at":"2026-01-11T14:02:13.316Z","repository":{"id":257800622,"uuid":"755957750","full_name":"gobst/buildadoc","owner":"gobst","description":"Generates a PHP class documentation for DokuWiki","archived":false,"fork":false,"pushed_at":"2025-03-05T21:31:16.000Z","size":700,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T21:53:11.146Z","etag":null,"topics":["documentation","dokuwiki","generator","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gobst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-11T15:28:32.000Z","updated_at":"2025-03-05T20:51:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"279d8d4e-4219-491b-b4d3-3e8caa5218a0","html_url":"https://github.com/gobst/buildadoc","commit_stats":null,"previous_names":["gobst/buildadoc"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/gobst/buildadoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gobst%2Fbuildadoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gobst%2Fbuildadoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gobst%2Fbuildadoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gobst%2Fbuildadoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gobst","download_url":"https://codeload.github.com/gobst/buildadoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gobst%2Fbuildadoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28306985,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T11:18:18.743Z","status":"ssl_error","status_checked_at":"2026-01-11T11:07:56.842Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","dokuwiki","generator","php"],"created_at":"2026-01-11T14:02:13.215Z","updated_at":"2026-01-11T14:02:13.293Z","avatar_url":"https://github.com/gobst.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Latest Stable Version](https://img.shields.io/packagist/v/gobst/buildadoc?label=latest%20stable\u0026color=darkgreen)\n![License](https://img.shields.io/packagist/l/gobst/buildadoc?label=license\u0026color=darkgreen)\n![PHP Version Required](https://img.shields.io/packagist/php-v/gobst/buildadoc?label=PHP%20required\u0026color=darkgreen)\n[![Coverage Status](https://coveralls.io/repos/github/gobst/buildadoc/badge.svg?branch=main)](https://coveralls.io/github/gobst/buildadoc?branch=main)\n[![Mutation testing badge](https://img.shields.io/endpoint?style=flat\u0026url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fgobst%2Fbuildadoc%2Fmain)](https://dashboard.stryker-mutator.io/api/reports/github.com/gobst/buildadoc/main)\n\n# BuildADoc\n\n## About\n\nBuildADoc is a PHP documentation generator designed specifically for [DokuWiki](https://github.com/dokuwiki/dokuwiki). \nIt parses your PHP classes and converts them into DokuWiki-compatible syntax for seamless integration with your documentation workflow.\n\n### Key Features:\n- Automatic generation of class documentation.\n- Easy integration with DokuWiki installations.\n- **Planned Features:**\n    - Markdown format support.\n    - `usedByClasses` feature for enhanced class relationship tracking.\n    - `trait` support.\n\n## Requirements\n- PHP 8.3 or higher\n- [Docker](https://www.docker.com/) (optional)\n\n## Installation\n\nTo install BuildADoc directly into your project you can use [Composer](https://getcomposer.org/) with the command:\n\n```bash\ncomposer require gobst/buildadoc\n```\n\n## Usage\n\n### 1. Within your project\n\nTo generate class documentation for DokuWiki, use the following command:\n\n```bash \nphp bin/console.php DokuWiki:create-doc path/to/src/ /path/to/destination/dir/ projectname\n```\n\nThe generated directories and files must be placed under your DokuWiki installation at /data/pages.\nFor more options and information run:\n\n```bash \nphp bin/console.php DokuWiki:create-doc -help\n```\n\n### 2. With Docker\n\nYou can also use the gobst/buildadoc Docker image to avoid setting up PHP dependencies directly on your system:\n\n```bash\ndocker run --rm --tty --volume \"$PWD:$PWD\" --workdir \"$PWD\" gobst/buildadoc php bin/console.php DokuWiki:create-doc src/ /path/to/destination/dir/ projectname\n```\n\n## Support\n\nIf you encounter any issues or have questions, feel free to open an issue in the [GitHub Issue Tracker](https://github.com/gobst/buildadoc/issues).\n\n## License\n\nDistributed under the BSD 3-Clause license. See [LICENSE](LICENSE) for more information.\n\n## Acknowledgments\n\n- [ApiGen](https://github.com/ApiGen/ApiGen) for inspiration.\n- [DokuWiki](https://github.com/dokuwiki/dokuwiki) for providing an excellent documentation platform.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgobst%2Fbuildadoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgobst%2Fbuildadoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgobst%2Fbuildadoc/lists"}