README

这是对 phpDocumentor v2 markdown 模板的大量修改版本。

此模板的主要用途是生成简单且外观优美的使用文档，然后可以发布到 GitHub/GitLab。

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

安装

使用 composer 安装

composer require ramynasr/phpdoc-markdown

使用方法

运行 phpDocumentor 并将模板设置为 vendor/ramynasr/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/ramynasr/phpdoc-markdown/data/templates/markdown" />
</phpdocumentor>

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

./vendor/bin/phpdoc && php ./vendor/ramynasr/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/ramynasr/phpdoc-markdown/bin/html-to-md.php"
}

然后运行

composer phpdoc

ramynasr / phpdoc-markdown

维护者

详细信息

README

安装

使用方法

使用配置文件示例