myst2mdx/blueprint/Dokka2Mdx

Dokka2Mdx

class Dokka2Mdx : CliktCommand

Dokka-generated HTML -> MDX (see blueprint.dokka.Html2Mdx), plus the Starlight frontmatter Html2Mdx deliberately doesn't add itself (it's a body-only converter — see its class KDoc). --in should point at the generated site's per-symbol subtree (e.g. tool/build/dokka/html/myst2mdx), not the whole dokka/html output — navigation.html/search-worker.json alongside it are pure site chrome. One exception: --in's own sibling index.html (one level up — the module's real "Packages" overview, not chrome) is also converted, into output/index.mdx — see run.

Constructors

constructor()

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

val commandName: String

val currentContext: Context

open val helpTags: Map<String, String>

open val hiddenFromHelp: Boolean

val input: String

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

val messages: List<String>

val output: String

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

open fun aliases(): Map<String, List<String>>

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

open fun ~~commandHelp~~(context: Context): String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context: Context): String

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

open fun help(context: Context): String

open fun helpEpilog(context: Context): String

fun issueMessage(message: String)

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CoreCliktCommand>

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

fun resetContext(parent: Context?): Context

open override fun run()

open override fun toString(): String