README

用于生成 Markdown 文档的 phpDocumentor v3 模板。

这是 phpDocumentor v2 Markdown 模板的一个经过大量修改的版本。phpDocumentor v2 markdown template。

此模板的主要用例是生成简单且外观漂亮的用法文档，然后可以发布在 GitHub/GitLab 上。

例如，一个小型库可以在 DocBlock 注释中记录其公共 API，使用此模板生成 Markdown 文档，然后将其提交到 GitHub，以便与库一起轻松创建供其他开发者查看的漂亮文档。

安装

使用 composer 安装

composer require automattic/phpdoc-markdown

使用方法

运行 phpDocumentor 并将模板设置为 vendor/automattic/phpdoc-markdown/data/templates/markdown。 示例使用配置文件：

在项目根目录中添加一个名为 phpdoc.xml（或 phpdoc.dist.xml）的文件，内容如下，然后不带参数运行 phpdoc 命令。修改配置以适应您的项目。您可以在 phpDocumentor v3 配置此处了解更多信息。

<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor configVersion="3.0">
    <paths>
        <output>docs</output>
        <cache>.phpdoc/cache</cache>
    </paths>
    <template name="vendor/automattic/phpdoc-markdown/data/templates/markdown" />
</phpdocumentor>

在创建配置文件后，您现在可以不带参数运行 phpdoc，然后运行 php 脚本来修复生成的文件。

./vendor/bin/phpdoc && php ./vendor/automattic/phpdoc-markdown/bin/html-to-md.php --dir="docs"

或者，您可以将它添加到 composer.json 脚本部分，这是我这样做的方式。

"scripts": {
    "phpdoc": [
        "export COMPOSER_PROCESS_TIMEOUT=9000",
        "@phpdoc-run",
        "@phpdoc-fix"
    ],
    "phpdoc-run": "vendor/bin/phpdoc -v",
    "phpdoc-fix": "php vendor/automattic/phpdoc-markdown/bin/html-to-md.php"
}

然后运行

composer phpdoc

automattic / phpdoc-markdown

维护者

详细信息

README

安装

使用方法