View Source MDEx.Heading (MDEx v0.3.0)

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() :: %MDEx.Heading{
  level: pos_integer(),
  nodes: [MDEx.Document.md_node()],
  setext: boolean()
}