Skip to content

Commit

Permalink
lib/earmark_parser/options.ex: added Earmark.Parser.Options.t() (#484)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradhanks authored Feb 12, 2024
1 parent db5e8b6 commit 39a2045
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions lib/earmark_parser/options.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
defmodule Earmark.Parser.Options do

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

@type t :: %__MODULE__{
renderer: module(),
all: boolean(),
gfm: boolean(),
gfm_tables: boolean(),
breaks: boolean(),
footnotes: boolean(),
footnote_offset: non_neg_integer(),
wikilinks: boolean(),
parse_inline: boolean(),
annotations: String.t() | nil,
code_class_prefix: String.t() | nil,
file: String.t() | nil,
line: non_neg_integer(),
messages: MapSet.t(),
pure_links: boolean(),
sub_sup: boolean(),
pedantic: boolean(),
smartypants: boolean(),
timeout: integer() | nil
}
# What we use to render
defstruct renderer: Earmark.Parser.HtmlRenderer,
# Inline style options
Expand Down

0 comments on commit 39a2045

Please sign in to comment.