README

我将存档这个项目，但如果有人想要分支它，我会继续维护。我最后一次尝试 ig 与 phpdoc 一起使用是在版本 2.9.0，所以我相当肯定它将不再与版本 3.x 兼容。

phpDocumentor Markdown 模板

这基本上是 phpDocumentor 的 Clean 模板的 Markdown 版本。

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

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

安装

使用 composer 安装

composer require fr3nch13/phpdoc-markdown

使用方法

运行 phpDocumentor 并将模板设置为 vendor/fr3nch13/phpdoc-markdown/data/templates/markdown。

这需要使用 phpdoc.xml 文件，因为 phpDocumentor 只生成 html 文件，需要将它们更改为 md 文件，并且需要修改生成的模板中的链接。这通过 bin 目录中的 php 脚本完成，该脚本使用 phpdoc.xml 文件来确定生成的模板位置。

使用配置文件示例

将名为 phpdoc.xml 的文件添加到项目的根目录，并使用不带参数的 phpdoc 命令调用。根据您的项目修改配置。

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>My Project Documentation</title>
    <parser>
        <target>build</target>
    </parser>
    <transformer>
        <target>docs</target>
    </transformer>
    <transformations>
        <template name="vendor/fr3nch13/phpdoc-markdown/data/templates/markdown" />
    </transformations>
    <files>
        <directory>src</directory>
        <ignore>test/*</ignore>
    </files>
</phpdoc>

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

$ vendor/bin/phpdoc && php vendor/fr3nch13/phpdoc-markdown/bin/fixHtmltoMd.php

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

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

然后运行

$ composer phpdoc

有关配置 phpDocumentor 的更多信息，请参阅配置文档。

包管理器: fr3nch13/phpdoc-markdown

fr3nch13 / phpdoc-markdown

维护者

详细信息

README

phpDocumentor Markdown 模板

安装

使用方法