a9f/fractor-doc-generator

Generate docs for Fractor

v0.4.0 2024-09-30 19:37 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

MIT

• Andreas Wolf

README

Generate Documentation for your Fractor rules

Installation

composer require a9f/fractor-doc-generator --dev

Usage

To generate documentation from rules, use generate command with paths that contain the rules:

vendor/bin/fractor-doc-generator generate src/rules

The file will be generated to /docs/rules_overview.md by default. To change that, use --output-file:

vendor/bin/fractor-doc-generator generate src/rules --output-file docs/my_rules.md

Happy coding!

Development

Development happens in the Fractor monorepo on GitHub