samsara/roster

A PHP console tool to generate Markdown documentation from your docblocks and types hints using templates.

v0.1.5 2021-07-08 11:13 UTC

Requires

• php: >=8.0
• hassankhan/config: ^2.2
• opis/json-schema: ^2.0
• samsara/mason: ^0.2
• symfony/console: ^v5.3
• symfony/yaml: ^5.3

GPL-3.0-only

• Jordan LeDoux

• documentation
• cli
• template
• markdown
• console
• command line
• material design
• mkdocs
• rtd

README

Installation

To install, simply require the package using composer:

composer --dev require "samsara/roster:^0.1"

Or include it in your composer.json file:

{
    "require-dev": {
        "samsara/roster": "^0.1"
    }
}

The project namespace is Samsara\Roster\*. You can view the project on Packagist.

Examples of Documentation Built With Roster

• Roster: This console program! Of course Roster builds its own documentation. :)
• Fermat: An arbitrary precision math library with trigonometry, statistics and more for PHP.

Documentation

After installing, from your project root on the command-line use:

php vendor/bin/roster [SOURCES_ROOT]

You can read the full documentation for Roster here.