EarmarkParser.Options (EarmarkParser v1.4.16-pre1) View Source
Link to this section Summary
Functions
Use normalize before passing it into any API function
Link to this section Types
Specs
inline_code_continuation() :: {nil | String.t(), number()}
Specs
maybe(t) :: t | nil
Specs
message() :: {message_type(), number(), String.t()}
Specs
message_type() :: :warning | :error
Specs
numbered_line() :: %{
:line => String.t(),
:lnb => number(),
optional(:inside_code) => String.t()
}
Specs
t() :: %EarmarkParser.Options{
annotations: term(),
breaks: boolean(),
code_class_prefix: maybe(String.t()),
file: term(),
footnote_offset: number(),
footnotes: boolean(),
gfm: boolean(),
gfm_tables: term(),
line: term(),
mapper: term(),
mapper_with_timeout: term(),
messages: term(),
parse_inline: boolean(),
pedantic: boolean(),
pure_links: boolean(),
renderer: term(),
smartypants: boolean(),
timeout: maybe(number()),
wikilinks: boolean()
}
Specs
token() :: {atom(), String.t()}
Specs
tokens() :: [token()]
Link to this section Functions
Use normalize before passing it into any API function
iex(1)> options = normalize(annotations: "%%")
...(1)> options.annotations
~r{\A(.*)(%%.*)}