garrcomm/markdown-generator

Class Documentation generator

v1.x-dev 2024-10-23 19:24 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.4
• squizlabs/php_codesniffer: ^3.5

CC-BY-SA-4.0

• Stefan Thoolen

• markdown

README

For my code projects, I like to provide proper documentation. Best way, in my opinion, is to start with well-documented code.

To generate markdown formatted documentation based on the codebase, I wrote this small tool.

It uses PHP Reflection to read out code information and formats according to the structure used on php.net documentation.

These projects can be used as an example:

Library	Markdown file	Config
garrcomm/uuid	README.md	.mdgen.json
garrcomm/networking-utilities	README.md	.mdgen.json

How to use

Usage is very simple;

1. Load this package by composer with

   composer require garrcomm/markdown-generator v1.x-dev --dev
   

2. Create a config file (see the list above for examples)
3. Execute the generator;

   vendor/bin/mdgen mdgen.json