Dokka aggregator for Material for MkDocs/opensavvy.dokka.material.mkdocs.aggregator/MarkdownMultimoduleLocationProvider

MarkdownMultimoduleLocationProvider

class MarkdownMultimoduleLocationProvider(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext) : MultimoduleLocationProvider(source)

A MultimoduleLocationProvider that generates .md links instead of the default .html ones. Used by DokkaMkDocsAggregationPlugin for the aggregation task so that cross-module links and the all-modules index page use proper Markdown file paths.

Kept in the aggregator module (not the renderer) so that the dependency on all-modules-page-plugin is only required on the aggregation classpath.

Constructors

constructor(pageGraphRoot: RootPageNode, dokkaContext: DokkaContext)

Types

Factory

class Factory(context: DokkaContext) : LocationProviderFactory

Properties

extension

val extension: String

Functions

ancestors

open override fun ancestors(node: PageNode): List<PageNode>

anchorForDCI

open fun anchorForDCI(dci: DCI, sourceSets: Set<DisplaySourceSet>): String

expectedLocationForDri

open fun expectedLocationForDri(dri: DRI): String

pathToRoot

open override fun pathToRoot(from: PageNode): String

resolve

open override fun resolve(dri: DRI, sourceSets: Set<DisplaySourceSet>, context: PageNode?): String?

open override fun resolve(node: PageNode, context: PageNode?, skipExtension: Boolean): String?