a9f / fractor-doc-generator
为 Fractor 生成文档
v0.3.0
2024-07-13 10:17 UTC
Requires
- php: ^8.2
- nette/utils: ^4.0
- sebastian/diff: ^4.0 || ^5.0 || ^6.0
- symfony/config: ^5.4 || ^6.4 || ^7.0
- symfony/console: ^5.4 || ^6.4 || ^7.0
- symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
Requires (Dev)
- symplify/rule-doc-generator: 12.1.3
README
为您的 Fractor 规则生成文档
安装
composer require a9f/fractor-doc-generator --dev
用法
要从规则生成文档,请使用包含规则的路径的 generate
命令
vendor/bin/fractor-doc-generator generate src/rules
默认情况下,文件将生成到 /docs/rules_overview.md
。要更改此设置,请使用 --output-file
vendor/bin/fractor-doc-generator generate src/rules --output-file docs/my_rules.md
编码愉快!
开发
开发在 GitHub 上的 Fractor 单一仓库 进行