markdownz_inline (markdownz v1.0.1)

View Source

Inline Markdown rules. Rules consume the beginning of a binary and return z_html_parse compatible nodes.

Summary

Types

html_element/0
result/0
state/0

Functions

decode_entities(Bin)
default_rules()
normalize_destination(Destination)
normalize_link_text(Url)
parse(Source, State)
rule_autolink(Source, State)
rule_code(Source, State)
rule_emphasis(Source, State)
rule_entity(Source, State)
rule_escape(_, State)
rule_html(Source, State)
rule_image(_, State)
rule_link(_, State)
rule_linkify(Source, State)
rule_newline(Source, State)
rule_strikethrough(Source, State)
rule_strong(Source, State)
rule_subscript(Source, State)
rule_superscript(Source, State)
rule_text(Source, State)

Types

html_element/0

-type html_element() :: markdownz:html_element().

result/0

-type result() :: nomatch | {ok, [html_element()], binary(), state()}.

state/0

-type state() :: map().

Functions

decode_entities(Bin)

-spec decode_entities(binary()) -> binary().

default_rules()

-spec default_rules() -> markdownz_ruler:ruler().

normalize_destination(Destination)

-spec normalize_destination(binary()) -> binary().

parse(Source, State)

-spec parse(binary(), state()) -> {[html_element()], state()}.

rule_autolink(Source, State)

-spec rule_autolink(binary(), state()) -> result().

rule_code(Source, State)

-spec rule_code(binary(), state()) -> result().

rule_emphasis(Source, State)

-spec rule_emphasis(binary(), state()) -> result().

rule_entity(Source, State)

-spec rule_entity(binary(), state()) -> result().

rule_escape(_, State)

-spec rule_escape(binary(), state()) -> result().

rule_html(Source, State)

-spec rule_html(binary(), state()) -> result().

rule_image(_, State)

-spec rule_image(binary(), state()) -> result().

rule_link(_, State)

-spec rule_link(binary(), state()) -> result().

rule_linkify(Source, State)

-spec rule_linkify(binary(), state()) -> result().

rule_newline(Source, State)

-spec rule_newline(binary(), state()) -> result().

rule_strikethrough(Source, State)

-spec rule_strikethrough(binary(), state()) -> result().

rule_strong(Source, State)

-spec rule_strong(binary(), state()) -> result().

rule_subscript(Source, State)

-spec rule_subscript(binary(), state()) -> result().

rule_superscript(Source, State)

-spec rule_superscript(binary(), state()) -> result().

rule_text(Source, State)

-spec rule_text(binary(), state()) -> result().