MarkdownModelExporter

Renders selected canonical elements as nested MkDocs admonitions using Dokka's model presentation rules.

Output layout mirrors the consumer's Gradle module layout, not the Kotlin package layout: <output>/<module path>/<viewpoint folder>/<source filename>.md, e.g. <output>/components/pecu/cdds/PthAdc/analysis/PthAdcAnalysis.md.

Forward and reverse relations use StigModelRelations, shared with the Dokka HTML pipeline. Admonition types are the lowercase names of the actual STIG metamodel classes. Every link resolves only to a page actually being written in this invocation; a reference to an element outside the current module/viewpoint selection renders as plain text and is recorded in unresolvedRelations. MarkdownExport.failOnUnresolvedLinks rejects such exports.

Constructors

Link copied to clipboard
constructor(bindings: ModelBindings)

Properties

Link copied to clipboard

Diagnostics from the most recent export, including an export that failed its strict link check.

Functions

Link copied to clipboard
fun export(selection: MarkdownExport): List<File>
Generated with STIG