View Source API Reference Earmark v1.4.47

Earmark

Abstract Syntax Tree and Rendering

The AST generation has now been moved out to EarmarkParser which is installed as a dependency.

Tools for AST manipulation

The Earmark CLI

Functional (with the exception of reading input files with Earmark.File) interface to the CLI returning the device and the string to be output.

This acts as a proxy to adapt to changes in Earmark.Parser's API

All public functions that are internal to Earmark, so that only external API functions are public in Earmark

This is a superset of the options that need to be passed into Earmark.Parser.as_ast/2

API

Earmark.Parser.as_ast

This is the structure of the result of as_ast.

Some extensions of Enum functions

Determines how markdown is parsed into an abstract syntax tree (AST) and subsequently rendered to HTML.

This struct represents a list of tuples {tag, function} from which a postprocessing function can be constructed

Structure Conserving Transformers

For the convenience of processing the output of Earmark.Parser.as_ast we expose two structure conserving mappers.

A wrapper struct that wraps a mapping function and is pushed onto the stack for traversal. This not only allows to pop from the stack onto the result but to store an older mapper function for usage of a replacement mapper function for the subtree traversal