View Source Earmark.Parser.Options (Earmark v1.4.47)

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

Summary

Types

t()

Functions

normalize(options)

Use normalize before passing it into any API function

Types

t()

@type t() :: %Earmark.Parser.Options{
  all: boolean(),
  annotations: String.t() | nil,
  breaks: boolean(),
  code_class_prefix: String.t() | nil,
  file: String.t() | nil,
  footnote_offset: non_neg_integer(),
  footnotes: boolean(),
  gfm: boolean(),
  gfm_tables: boolean(),
  line: non_neg_integer(),
  messages: MapSet.t(),
  parse_inline: boolean(),
  pedantic: boolean(),
  pure_links: boolean(),
  renderer: module(),
  smartypants: boolean(),
  sub_sup: boolean(),
  timeout: integer() | nil,
  wikilinks: boolean()
}

Functions

normalize(options)

@spec normalize(Earmark.Options.options()) :: Earmark.Options.options()

Use normalize before passing it into any API function

  iex(1)> options = normalize(annotations: "%%")
  ...(1)> options.annotations
  ~r{\A(.*)(%%.*)}