MdcDocument class final

One parsed Markdown Components document.

Available extensions

Constructors

MdcDocument({Iterable<MdcNode> nodes = const <MdcNode>[], Map<String, Object?> frontmatter = const <String, Object?>{}})
Creates an immutable document.

Properties

frontmatter → Map<String, Object?>
YAML frontmatter normalized to JSON-compatible Dart values.
final
hashCode → int
The hash code for this object.
no setterinherited
nodes → List<MdcNode>
The document body in source order.
final
outline → List<MdcOutlineEntry>

Available on MdcDocument, provided by the MdcDocumentOutline extension

Returns the document headings as an immutable hierarchy.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
withHeadingIds() → MdcDocument

Available on MdcDocument, provided by the MdcDocumentOutline extension

Returns this document with a stable id on every heading.

Operators

operator ==(Object other) → bool
The equality operator.
inherited