Documentation Generation

Generate docs from handlers

php bin/generate-docs.php --format=markdown --output=docs/api.md
php bin/generate-docs.php --format=html --output=docs/api.html
php bin/generate-docs.php --format=json --output=docs/api.json
php bin/generate-docs.php --format=openrpc --output=docs/openrpc.json

Supported formats

FormatDescription
markdownMarkdown documentation (default)
htmlStyled HTML page
jsonMachine-readable JSON
openrpcOpenRPC 1.3.2 specification

Doc metadata sources

Documentation is generated from: