markdown/com.varabyte.kobwebx.gradle.markdown/MarkdownEntry

MarkdownEntry

class MarkdownEntry(val filePath: String, val frontMatter: Map<String, List<String>>, val route: String, val fqn: String)(source)

An entry representing a markdown resource and some relevant data about it.

Constructors

MarkdownEntry

constructor(filePath: String, frontMatter: Map<String, List<String>>, route: String, fqn: String)

Properties

filePath

val filePath: String

The path to the markdown file, relative from the resources/markdown root.

fqn

val fqn: String

The fully qualified name to the main composable method generated by this markdown file. This can be useful when creating a listing file by adding import ${markdown.fqn} in the generated file.

frontMatter

val frontMatter: Map<String, List<String>>

FrontMatter key/value pairs parsed from the markdown file. It can be useful to allow specifying metadata in your markdown files which you can query and use during the process step.

route

val route: String

The route that this markdown file will be served at. This is usually just filePath with the extension removed, but there are ways to override it (both in Gradle and via front matter).