core

core/dev.fishies.coho.markdown/ProcessedMarkdownFile

ProcessedMarkdownFile

open class ProcessedMarkdownFile(var content: String, val path: Path, val markdownTemplate: MarkdownTemplate, val attributesCustomizer: StatefulAttributeCustomizer) : MarkdownFile

Constructors

ProcessedMarkdownFile

constructor(content: String, path: Path, markdownTemplate: MarkdownTemplate, attributesCustomizer: StatefulAttributeCustomizer)

Properties

attributesCustomizer

val attributesCustomizer: StatefulAttributeCustomizer

var content: String

open val count: Int = 1

var executionTime: Duration?

var frontmatter: Map<String?, Any?>

The 'frontmatter' of the Markdown document; e.g., the section that comes before the content:

markdownTemplate

val markdownTemplate: MarkdownTemplate

val name: String

var tagRenderer: HtmlGenerator.TagRenderer

Functions

open fun generate(location: Path? = null): Path

headingIDAttributeCustomizer

fun ProcessedMarkdownFile.headingIDAttributeCustomizer(node: ASTNode, tagName: CharSequence, attributes: Iterable<CharSequence?>): Iterable<CharSequence?>

hrefFixingAttributesCustomizer

fun ProcessedMarkdownFile.hrefFixingAttributesCustomizer(node: ASTNode, tagName: CharSequence, attributes: Iterable<CharSequence?>): Iterable<CharSequence?>

Attribute customizer that remaps hrefs in links to point to HTML files instead of Markdown files.

ogMetadataTemplate

fun ProcessedMarkdownFile.ogMetadataTemplate(html: String): String

A default template for md that adds OpenGraph meta tags to the HTML.

open override fun toString(): String