包简介

generates readme with public api documentation for php packages

README 文档

README

Automatically generates a 📚 README file with public API documentation for a PHP package, based on docblocks and package information from composer.json

Included formatters:

Markdown

📔 Go to documentation

Installation

Installation via composer:

composer require tomrf/readme-gen

Usage

$readmeGen = new \Tomrf\ReadmeGen\ReadmeGen('.'); // path to project directory

echo $readmeGen->generate(
    new Tomrf\ReadmeGen\Formatter\MarkdownFormatter(
        \phpDocumentor\Reflection\DocBlockFactory::createInstance(),
        new \phpDocumentor\Reflection\Types\ContextFactory()
    ),
    'resources/template.md'
);

Testing

composer test

License

This project is released under the MIT License (MIT). See LICENSE for more information.

Documentation

Tomrf\ReadmeGen\ReadmeGen
- __construct
- generate

📂 Tomrf\ReadmeGen\ReadmeGen::class

ReadmeGen.

Very much a work in progress.

__construct()

public function __construct(
    string $projectRoot
): void

generate()

public function generate(
    Tomrf\ReadmeGen\Interface\ReadmeFormatterInterface $formatter,
    string $templateFilename
): string

Generated 2022-06-15T22:33:50+02:00 using 📚tomrf/readme-gen

tomrf/readme-gen 适用场景与选型建议

tomrf/readme-gen 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 38 次下载、GitHub Stars 达 1，最近一次更新时间为 2022 年 06 月 15 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「markdown」「readme」「README.md」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 tomrf/readme-gen 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 tomrf/readme-gen 我们能提供哪些服务？

定制开发 / 二次开发

基于 tomrf/readme-gen 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 tomrf/readme-gen 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

dg/texy 159

Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

fojuth/readmegen 61

Readme file / doc generator. It uses VCS logs as a source of information.

code-orange/jot 7

Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.

diviky/laravel-readme 0

Framework extension

litalino/flarum-more-bbcode 2

Adds more BBCode