From c172b289a6ed8134ebd2636223ff5c0f3ace9d14 Mon Sep 17 00:00:00 2001 From: Brad Hanks Date: Mon, 5 Feb 2024 01:18:50 -0700 Subject: [PATCH] lib/earmark_parser/options.ex: added Earmark.Parser.Options.t() --- lib/earmark_parser/options.ex | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/lib/earmark_parser/options.ex b/lib/earmark_parser/options.ex index 3f6a6522..89ace5f3 100644 --- a/lib/earmark_parser/options.ex +++ b/lib/earmark_parser/options.ex @@ -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