ergoplatform / ergoplatform/ergo-appkit

Generate commands list as Markdown table

Open
#45 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
44
Forks
34
PR merge metrics
No merged PRs in 30d

Description

## Problem
Each `CliApplication` implements a list of commands.
This list can be printed in console output as part of usage help message.
However, it is usually required to have this list also in a documentation page.
The corresponding section of the doc page can thus be generated for any CliApplication instance.

## Solution
Implement the `genMarkdown` method which uses `commands` method for a list of supported commands.

[Example](https://github.com/ergoplatform/ergo-tool#supported-commands)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.