quarkdown-quarkdoc-reader/com.quarkdown.quarkdoc.reader.json/DocsIndexWalker

DocsIndexWalker

class DocsIndexWalker(indexes: List<String>) : DocsWalker<DocsIndexContentExtractor>

Walker of pre-extracted DocsIndex payloads, the fast path over com.quarkdown.quarkdoc.reader.dokka.DokkaHtmlWalker: content is already in Markdown and requires no HTML processing.

A documentation tree may carry multiple DOCS_INDEX_FILE_NAME files, one per documentation module, whose entries are merged.

Parameters

indexes

the raw JSON content of each index file

See also

fromDirectoryOrNull

to discover and read the index files of a local documentation directory

Constructors

Link copied to clipboard
constructor(indexes: List<String>)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun walk(): Sequence<DocsWalker.Result<DocsIndexContentExtractor>>

Scans documentation resources.

Generated by Dokka
© 2026 Quarkdown