README

PHPDoc-VuePress

用于生成您PHP API文档的VuePress格式模板。

本包提供了一个 phpDocumentor 2 模板，用于生成您的代码的API文档，并集成到看起来很棒的 VuePress 项目中。

正在进行中: 🚧🏗 正在推进与phpDocumentor 3的兼容性。

功能

此模板将在目标目录中生成六个VuePress *.md 文件，其中包含DocBlock文档

README.md: API文档的入口点。目前包含简介和网站中使用的块的引用。
classes.md: 包含所有类，按命名空间排序。
interfaces.md: 包含所有接口，按命名空间排序。
traits.md: 包含所有特性，按命名空间排序。
constants.md: 包含所有全局常量，按命名空间排序。
functions.md: 包含所有全局函数，按命名空间排序。

演示

查看使用此模板生成的文档演示 https://phpdoc-vuepress.netlify.app/demo

探索 nelson6e65/phpdoc-vuepress 的源代码以使用配置文件作为指南。

使用此模板生成的真实项目API： nelson6e65/php_nml。

要求

PHP >= 5.6 < 8.0
Node.js >= 8 < 18
phpDocumentor 2.
Yarn (或 npm)
VuePress.

此模板是为 phpDocumentor 2 和 VuePress 1 设计的。有关依赖项的更多信息，请参阅文档。

注意：phpDocumentor 2能够为可能任何版本的PHP < 8编写的代码生成文档，但应该在PHP 7.2上运行。如果您不在本地环境中使用它，可以配置CI（如Travis CI、Netlify或GitHub Actions）以在PHP 7.2上生成您的代码的文档。正在推进与phpDocumentor 3的兼容性以支持它提供的新功能。

安装

使用Composer安装 nelson6e65/phpdoc-vuepress

composer require --dev nelson6e65/phpdoc-vuepress

注意：预发布版：您可能需要将composer选项minimum-stability 设置为 'dev' 或 'beta'，以便能够安装预发布版。

用法

运行phpDocumentor并将模板设置为 vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress

phpdoc -d="src/" -t="docs/api/" --template="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress"

有关可用参数的更多信息，请参阅运行phpDocumentor。

配置

请参阅文档中的配置部分以获取设置示例。

进一步阅读

请参阅https://nelson6e65.github.io/phpdoc-vuepress/ 的文档以获取更多信息。

贡献

请查阅CONTRIBUTING.md 文件以了解有关贡献的详细信息。

许可

请阅读许可证文件以获取详细信息。

注意：本模板基于由@cvuorinen创建的Markdown模板：cvuorinen/phpdoc-markdown-public。

nelson6e65 / phpdoc-vuepress

维护者

详细信息

README

PHPDoc-VuePress

功能

演示

要求

安装

用法

配置

进一步阅读

贡献

许可