MarkdownExportDsl

Properties

Link copied to clipboard

Optional four presentation groups around existing interface-point analyses, including empty groups.

Link copied to clipboard
Link copied to clipboard

Fail when any model relation has no exported destination instead of accepting plain text.

Link copied to clipboard

Ends each exported Analysis page with a table linking the analyses of the elements it contains, for example the component analyses on a cluster page. An analysis is listed under the analysis of its nearest ancestor element that also has an exported, enabled analysis. An authored <!-- STIG: child analyses --> insertion point instead renders a module-folder hierarchy with classification and recorded assessment arguments, including QM elements.

Link copied to clipboard

Disable when the destination site computes reverse links while rendering. Forward links are always exported.

Link copied to clipboard

Model table-of-contents labels; names include derived interface-point analysis names.

Link copied to clipboard

Merges exact exported page paths into the selected module-root navigation branches.

Functions

Link copied to clipboard
fun configFile(file: File)
fun configFile(file: Provider<RegularFile>)

fun configFile(path: String)

Existing MkDocs YAML configuration; its docs_dir (default docs) supplies the Markdown destination.

Link copied to clipboard
fun fromModules(vararg selected: String)

Selects project paths relative to the root (e.g. "components/pecu/cdds/PthAdc"), matching the consumer's directory layout. Supports Ant-style globs: a single * matches within one path segment; a doubled star matches across segments, so a pattern ending in a doubled-star segment below components/pecu selects every project nested under it.

Link copied to clipboard
fun navBranch(moduleRoot: String, title: String)

Overrides the title of a selected module root, for example navBranch("components", "SW components").

Link copied to clipboard
fun navParent(vararg titles: String)

Exact navigation titles leading to the parent of the generated branches; empty means top-level nav.

Link copied to clipboard
fun output(file: StigRepoFile)
fun output(file: File)
fun output(file: Provider<RegularFile>)

fun output(path: String)

Destination root directory; one file per selected element/viewpoint is written beneath it.

Link copied to clipboard
fun publishing(configure: MkDocsPublishingDsl.() -> Unit)

Publication paths passed to the destination MkDocs site's publisher with the exported model.

Link copied to clipboard
fun viewpoints(vararg selected: Viewpoint)

Select the CREATE viewpoints to export.