rudra/docs

Command line tool for generating markdown-formatted class documentation

v26.7 2026-06-18 13:52 UTC

Requires

• php: ^8.3
• rudra/cli: v26.7
• rudra/container: v26.7

MPL-2.0

• Korotkov Danila

• generator
• markdown
• rudra

README

Rudra-Documentation-Collector | API

Install

composer require rudra/docs

Generate docs for all classes in a source directory

$ ./vendor/bin/rudra-docs

Add a command to Rudra Framework config/commands.yml

make:docs:
  - Rudra\Markdown\Command\MakeDocumentation

Specify the path of the required folder with classes

Enter source directory: src or Enter source directory: vendor/rudra/cli

Specify the name of the output file .md

Enter file name: api

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) — a free, open-source license that:

• Requires preservation of copyright and license notices,
• Allows commercial and non-commercial use,
• Requires that any modifications to the original files remain open under MPL-2.0,
• Permits combining with proprietary code in larger works.

📄 Full license text: LICENSE
🌐 Official MPL-2.0 page: https://mozilla.org/MPL/2.0/