quarkdown-core/com.quarkdown.core.rendering

Package-level declarations

Types

interface NodeRenderer : NodeVisitor<CharSequence>

A rendering strategy, which converts nodes from the AST to their output code representation.

Strategy used to run the post-rendering stage: the rendered content from the rendering stage is injected into a template offered by the post-renderer. Additionally, the post-renderer provides the output resources that can be saved to file.

PostRendererVisitor

interface PostRendererVisitor<T>

Visitor for PostRenderers

RenderingComponents

data class RenderingComponents(val nodeRenderer: NodeRenderer, val postRenderer: PostRenderer)

A pair of a node renderer and a post-renderer, provided by a com.quarkdown.core.flavor.RendererFactory. For example, an HTML node renderer converts a node to an HTML tag, and an HTML post-renderer wraps the rendered content in a template. Hence, it's a good idea to pair them together to ensure consistency.

UnsupportedRenderException

class UnsupportedRenderException(elementClass: KClass<*>) : UnsupportedOperationException

An exception thrown when a com.quarkdown.core.rendering.NodeRenderer tries rendering a node which is unsupported by its flavor.

Functions

wrap

fun PostRenderer.wrap(content: CharSequence): CharSequence

Wraps rendered code in a template.