MordantMarkdownHelpFormatter

open class MordantMarkdownHelpFormatter(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false) : MordantHelpFormatter

A HelpFormatter that uses Mordant to render its output as GitHub Flavored Markdown.

To customize help text, you can create a subclass and set it as the helpFormatter on your command's context.

Constructors

constructor(context: Context, requiredOptionMarker: String? = null, showDefaultValues: Boolean = false, showRequiredTag: Boolean = false)

open override fun formatHelp(error: UsageError?, prolog: String, epilog: String, parameters: List<HelpFormatter.ParameterHelp>, programName: String): String

open override fun renderWrappedText(text: String): Widget