通过
进行搜索
进行搜索lluiscamino / php-doc2pdf
为您的PHP项目创建格式化的PDF文档。
v1.0.0-alpha
2019-06-21 13:23 UTC
Requires
- erusev/parsedown: dev-master
- league/plates: 3.*
- mpdf/mpdf: dev-master
- phpdocumentor/reflection: ~4.0
- symfony/console: ^4.3@dev
This package is auto-updated.
Last update: 2024-09-23 23:40:35 UTC
README
为您的PHP项目创建格式化的PDF文档。
phpDoc2pdf使用phpDocumentor/Reflection库从您的项目中提取类、接口和特性，并生成一组类似于phpDocumentor2提供的文档，但以PDF格式。
您可以在docs文件夹中查看一些示例。
入门
以下说明将帮助您在本地机器上运行项目副本以进行开发和测试。
安装
- 直接从此处下载PHAR文件。
用法
使用以下命令生成文档
php phpDoc2pdf.phar create <INPUT> <OUTPUT>
将<INPUT>替换为您想要文档化的PHP文件或目录，将<OUTPUT>替换为文档将保存的目录。
请注意，您想要文档化的文件必须是UTF-8格式。
构建使用
- phpDocumentor2/Reflection
- Symfony/Console
- mpdf
- thephpleague/plates
- erusev/parsedown
- sebastianbergmann/phpunit
贡献
所有贡献都受到欢迎，请查看下面的待办事项列表或提出建议。🤗
待办事项列表
- 添加测试
- 添加markdown支持
- 添加模板系统
- 将生成的文档分离到不同的子目录中
- 简化安装和用法
- 在方法参数上包含phpDocBlock类型
- 添加对所有类型文件扩展名的支持。
许可证
此项目受MIT许可证的许可 - 有关详细信息，请参阅LICENSE文件