搜索onspli / phpdoc-markdown
生成Markdown格式的文档，以便可以在GitHub上发布。
README
phpDocumentor模板，仅生成公共API的Markdown文档到单个README.md文件。它将跳过所有抽象类和非公共方法。由Carl Vuorinen的cvuorinen/phpdoc-markdown-public模板分支。
此模板的主要用例是生成简单且外观漂亮的文档，然后可以在GitHub上发布。
例如，一个小型库可以在DocBlock注释中记录其公共API，使用此模板生成Markdown文档，然后将它与库一起提交到GitHub，以便为其他开发者创建易于查看的文档。
使用此模板生成的文档示例：https://github.com/onspli/chess/tree/master/docs
安装
使用Composer安装
composer require onspli/phpdoc-markdown
使用方法
首先，您需要安装phpDocumentor。有多种安装方式，其中一种是通过PHAR。
$ wget https://phpdoc.org/phpDocumentor.phar
更多关于phpDocumentor安装的信息。请注意，phpDocumentor也通过Composer提供，但其文档中声明
啊，你发现了我们的秘密。有一个phpDocumentor composer包，您可以使用它来安装phpDocumentor。
然而：phpDocumentor是一个复杂的应用程序，其库被无数其他库和应用使用（我们的一些库下载量超过1.5亿次）；这意味着您的一个依赖与您的依赖发生冲突的可能性非常高。当我说是高时，确实是非常高。
因此，鉴于上述原因：我们不推荐也不积极支持使用Composer安装phpDocumentor。
接下来，运行phpDocumentor并设置模板为vendor/onspli/phpdoc-markdown/templates/public-onefile。
$ php phpDocumentor.phar --directory=src --target=docs --template=vendor/onspli/phpdoc-markdown/templates/public-onefile
文档将生成到docs/README.md文件。
有关配置phpDocumentor的更多信息。