{"id":21526061,"url":"https://github.com/nelson6e65/phpdoc-vuepress","last_synced_at":"2025-04-09T23:32:50.028Z","repository":{"id":33786612,"uuid":"162250343","full_name":"nelson6e65/phpdoc-vuepress","owner":"nelson6e65","description":"🎨 Template for generating your PHP API documentation in a pretty VuePress format","archived":false,"fork":false,"pushed_at":"2023-03-05T10:08:19.000Z","size":2224,"stargazers_count":21,"open_issues_count":22,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-17T09:34:07.402Z","etag":null,"topics":["api-documentation","composer","docblock","php","phpdoc","phpdoc-vuepress","phpdocumentor","vuepress"],"latest_commit_sha":null,"homepage":"https://phpdoc-vuepress.netlify.app","language":"Twig","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/nelson6e65.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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},"funding":{"patreon":"nelson6e65","custom":["https://paypal.me/n6e65"]}},"created_at":"2018-12-18T07:48:32.000Z","updated_at":"2023-07-11T09:39:54.000Z","dependencies_parsed_at":"2024-06-21T17:50:43.610Z","dependency_job_id":"a52f5957-99e5-497c-b3d2-39e8f91d741e","html_url":"https://github.com/nelson6e65/phpdoc-vuepress","commit_stats":{"total_commits":184,"total_committers":2,"mean_commits":92.0,"dds":0.1467391304347826,"last_synced_commit":"4961b132b26c66ab03c149d58d6338773767f38b"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nelson6e65%2Fphpdoc-vuepress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nelson6e65%2Fphpdoc-vuepress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nelson6e65%2Fphpdoc-vuepress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nelson6e65%2Fphpdoc-vuepress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nelson6e65","download_url":"https://codeload.github.com/nelson6e65/phpdoc-vuepress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248129728,"owners_count":21052630,"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":["api-documentation","composer","docblock","php","phpdoc","phpdoc-vuepress","phpdocumentor","vuepress"],"created_at":"2024-11-24T01:41:55.674Z","updated_at":"2025-04-09T23:32:49.994Z","avatar_url":"https://github.com/nelson6e65.png","language":"Twig","funding_links":["https://patreon.com/nelson6e65","https://paypal.me/n6e65"],"categories":[],"sub_categories":[],"readme":"[![Card](./.github/assets/card.svg)](https://nelson6e65.github.io/phpdoc-vuepress)\n\n# PHPDoc-VuePress\n\n![Documentation build](https://img.shields.io/github/actions/workflow/status/nelson6e65/phpdoc-vuepress/documentation.yml?label=docs)\n\n![Packagist PHP Versions](https://img.shields.io/packagist/dependency-v/nelson6e65/phpdoc-vuepress/php)\n\n[![GitHub release](https://img.shields.io/github/tag/nelson6e65/phpdoc-vuepress.svg)](https://github.com/nelson6e65/phpdoc-vuepress/tags)\n[![Latest Version](https://img.shields.io/packagist/v/nelson6e65/phpdoc-vuepress.svg?label=stable)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress)\n[![Latest unstable Version](https://img.shields.io/packagist/vpre/nelson6e65/phpdoc-vuepress.svg?label=unstable)](https://packagist.org/packages/nelson6e65/phpdoc-vuepress#dev-master)\n\n[![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)\n[![Documentation](http://img.shields.io/badge/📜-Documentation-lightgrey.svg)](https://phpdoc-vuepress.netlify.app/)\n[![Wakatime](https://wakatime.com/badge/github/nelson6e65/phpdoc-vuepress.svg)](https://wakatime.com/badge/github/nelson6e65/phpdoc-vuepress)\n\nTemplate for generating your PHP API documentation in a pretty VuePress format.\n\nThis package provides a **phpDocumentor 2** template to generate the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.\n\n\u003e **WIP**: 🚧🏗 Compatibility with phpDocumentor 3 in progress.\n\n## Features\n\nThis template will generate six VuePress `*.md` files with the DocBlock documentation in your target directory:\n\n- `README.md`: Entry point of your API Documentation. Contains, at the moment, an introduction and references to blocks used in the site.\n- `classes.md`: Contains all classes, sorted by namespace.\n- `interfaces.md`: Contains all interfaces, sorted by namespace.\n- `traits.md`: Contains all traits, sorted by namespace.\n- `constants.md`: Contains all global constants, sorted by namespace.\n- `functions.md`: Contains all global functions, sorted by namespace.\n\n## Demo\n\nCheck a demo of documentation generated with this template in https://phpdoc-vuepress.netlify.app/demo\n\nExplore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/phpdoc-vuepress) to use configuration files as guide.\n\n\u003e A real project API generated using this template: [nelson6e65/php_nml](https://php-nml.netlify.app/api/).\n\n## Requirements\n\n- PHP \u003e= 5.6 \u003c 8.0\n- Node.js \u003e= 8 \u003c 18\n- [phpDocumentor](https://www.phpdoc.org/) 2.\n- [Yarn](https://yarnpkg.com) (or npm)\n- [VuePress](https://vuepress.vuejs.org/).\n\n\u003e This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 1](https://v0.vuepress.vuejs.org/).\n\u003e Read more about dependencies in the [Documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/getting-started.html).\n\n\u003e Note: phpDocumentor 2 is able to generate documentation of code written on maybe any version of PHP \u003c 8, but should be run on PHP 7.2. You can configure a CI like Travis CI, Netlify of Github Actions to generate the documentation on PHP 7.2 for your code if not using it on your local environment. Compatibility with phpDocumentor 3 is in progress 🚧 to support new features it offers.\n\n## Installation\n\nInstall `nelson6e65/phpdoc-vuepress` with composer:\n\n```bash\ncomposer require --dev nelson6e65/phpdoc-vuepress\n```\n\n\u003e **Note for pre-releases:** You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' or 'beta' in order to be able to install pre-releases.\n\n## Usage\n\nRun phpDocumentor and set template as `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`:\n\n```bash\nphpdoc -d=\"src/\" -t=\"docs/api/\" --template=\"vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress\"\n```\n\n\u003e More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).\n\n## Configuration\n\nSee the [Configuration section in the documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/configuration.html) for setup examples.\n\n## Further reading\n\nCheck the documentation for more information [https://nelson6e65.github.io/phpdoc-vuepress/](https://nelson6e65.github.io/phpdoc-vuepress/).\n\n## Contributing\n\nCheck out the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for details about contributing.\n\n## License\n\n[![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)\n\nCopyright (c) 2018-2023 Nelson Martell\n\nRead the [`LICENSE` file](LICENSE) for details.\n\n\u003e **Note:** This template is based on Markdown template created by [@cvuorinen](https://github.com/cvuorinen): [cvuorinen/phpdoc-markdown-public](https://github.com/cvuorinen/phpdoc-markdown-public).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnelson6e65%2Fphpdoc-vuepress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnelson6e65%2Fphpdoc-vuepress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnelson6e65%2Fphpdoc-vuepress/lists"}