MDExNative.Comrak.Heading (MDExNative v0.2.7)

A heading, either ATX or setext.

ATX is the most common heading, a line starting with 1-6 # characters, and setext is represented as one or more lines followed by a heading underline as === or ---.

Spec: https://github.github.com/gfm/#atx-headings and https://github.github.com/gfm/#setext-headings

Summary

Types

t()

Types

t()

@type t() :: %MDExNative.Comrak.Heading{
  attrs: MDExNative.Comrak.Attributes.t() | nil,
  closed: boolean(),
  level: pos_integer(),
  nodes: [MDExNative.Comrak.ast_node()],
  setext: boolean(),
  sourcepos: term()
}