Earmark v1.3.6 API Reference

Modules

API

Earmark.as_html

  {:ok, html_doc, []}                   = Earmark.as_html(markdown)
  {:ok, html_doc, deprecation_messages} = Earmark.as_html(markdown)
  {:error, html_doc, error_messages}    = Earmark.as_html(markdown)

Earmark.as_html!

  html_doc = Earmark.as_html!(markdown, options)

All messages are printed to stderr.

Given a list of parsed lines, convert them into blocks. That list of blocks is the final representation of the document (in internal form).

Match and render inline sequences, passing each to the renderer.

Defines all structs representing lines

Give a line of text, return its context-free type. Not for external consumption

DEPRECATED!!!