garrcomm/markdown-generator

Class Documentation generator

Maintainers

Details

bitbucket.org/garrcomm/markdowngenerator/

Homepage

Source

Issues

Documentation

Installs: 10

Dependents: 1

Suggesters: 0

Security: 0

v1.x-dev 2023-05-22 14:18 UTC

Requires

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

Requires (Dev)

CC-BY-SA-4.0 e30f4e928159d720f34e08ded10a64fec0e822e5

markdown

This package is auto-updated.

Last update: 2024-04-22 16:45:24 UTC

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.

An example of generated documentation can be found at https://bitbucket.org/garrcomm/php-uuid/src/v1/README.md.

How to use

Usage is very simple;

  1. Load this package by composer with 
    composer require garrcomm/markdown-generator --dev
  2. Create a config file (Example at https://bitbucket.org/garrcomm/php-uuid/src/v1/.mdgen.json)
  3. Execute the generator;
    vendor/bin/mdgen mdgen.json