core/dev.fishies.coho.markdown

Package-level declarations

Types

typealias MarkdownTemplate = ProcessedMarkdownFile.(html: String) -> String

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

StatefulAttributeCustomizer

typealias StatefulAttributeCustomizer = ProcessedMarkdownFile.(node: ASTNode, tagName: CharSequence, attributes: Iterable<CharSequence?>) -> Iterable<CharSequence?>

SyntaxHighlightedGFMFlavourDescriptor

open class SyntaxHighlightedGFMFlavourDescriptor(useSafeLinks: Boolean = true, absolutizeAnchorLinks: Boolean = false) : GFMFlavourDescriptor

Hacked together Markdown flavor descriptor to highlight codeblocks with Prism4j.

Functions

asMap

fun Any.asMap(): Map<*, *>

Convert Any to a Map in a way that's easily null-safetied.

compoundAttributeCustomizer

fun compoundAttributeCustomizer(vararg customizers: StatefulAttributeCustomizer): StatefulAttributeCustomizer

Meta-attribute customizer that applies a series of customizers.

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.

fun OutputPath.md(source: Path, markdownTemplate: MarkdownTemplate = this.markdownTemplate, attributesCustomizer: StatefulAttributeCustomizer = compoundAttributeCustomizer( ProcessedMarkdownFile::hrefFixingAttributesCustomizer, ProcessedMarkdownFile::headingIDAttributeCustomizer )): <Error class: unknown class>

Convert a Markdown file to an HTML body with the given template and attribute customizer. By default, hrefFixingAttributesCustomizer to retarget hrefs to html files and headingIDAttributeCustomizer to add IDs to headings are applied.

mdBasic

fun OutputPath.mdBasic(source: Path): <Error class: unknown class>

Convert a Markdown file to an HTML body directly with no templating or other post-processing. You likely don't want this one, use md for more flexibility.

ogMetadataTemplate

fun ProcessedMarkdownFile.ogMetadataTemplate(html: String): String

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