kobwebx-markdown/com.varabyte.kobwebx.markdown/MarkdownContext

MarkdownContext

class MarkdownContext(val path: String, val frontMatter: FrontMatterElement.ValueMap)(source)

Various context that will be set if this page was generated from Markdown.

To access it, use rememberPageContext in your composable and read the markdown field.

In other words, if you had Markdown like this, which called a Signature widget:

# Markdown.md

---
author: BitSpittle
date: 12-31-1999
---

... a bunch of content ...

{{ Signature() }}

then you might implement Signature like so:

// Signature.kt

@Composable
fun Signature() {
  val ctx = rememberPageContext()
  val markdown = ctx.markdown!! // Will be null if this composable was not called from within a markdown file
  // Markdown front matter value can be a list of strings, but here it's only a single one
  val author = markdown.frontMatter.getValue("author").single()
  Text("Article by $author")
}

Constructors

MarkdownContext

constructor(path: String, frontMatter: FrontMatterElement.ValueMap)

Properties

frontMatter

val frontMatter: FrontMatterElement.ValueMap

Exposes data set in a markdown file's front matter block. (Front matter is the YAML block optionally declared at the top of a markdown file, which is delimited by --- lines.)

path

val path: String

The path of the markdown file, including its extension, relative to the markdown root it was found in, e.g. a/b/c/Hello.md.