markright v0.2.5 API Reference

Modules

Custom syntax Markdown-like text processor

The buffer, used in continuations, stores the tail of the string parsed, tags that are already opened and arbitrary values in bag field

The default behaviour for all the collectors. Collectors are designed to be called on AST transformation to collect the data while the AST is being created

Collector that basically builds the Open Graph Protocol and Twitter Card

Collector for tags appeared in the content

The tuple, that is being returned from any call to Parser.to_ast/3

The default behaviour for all the finalizers

Finalizer for blockquote tag: makes last AST element fancy if it’s a link

Finalizer for dt tag: makes dt/dd pair out of it

Generic handler for flushes. Use as

Generic handler for leads. Use as

Generic handler for magnets. Use as

The default behaviour for all the parsers

Parses the whole text, producing a single article item

Parses the input for the block (delimited by empty lines.)

Parses the input for the blockquote block

The default break implementation, unsure if needed

Parses the input for the class and or id specified

Parses the input for the line item

The generic, aka topmost, aka multi-purpose parser, used when there is no specific parser declared for the tag

Parses the headers

The default horizontal rule implementation, unsure if needed

Parses the input for the link

Parses the input for the line item

Parses the input for the link

Makes all the mailto:who@where.domain texts to be links

The default magnet implementation, unsure if needed

Makes all the mailto:who@where.domain texts to be links

Parses the input for the code block

Parses the input for the line item

Parses the input until the first occurence of a space

The syntax definition/helpers

The utilities, used amongst the Markright

Exceptions