Skip to content

SiMarkdownRoot Type documentation

(Omit<Root, "children"> & { children: ExtendedRootContent[], references: { definitions: Map<string, Definition>, footnoteDefinitions: Map<string, FootnoteDefinition> } })
Extended root with references

Types Documentation

import
imported from @types/mdast
(RootContent | Footnotes | Citations | DirectiveNode)
import
imported from @types/mdast
extends Parent
Extra node for collecting all footnotes
Properties
List of children.
children: FootnoteDefinition[]
Info from the ecosystem.
data?: Data from Parent.data
Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.
position?: Position from Parent.position
Node type.
type: "footnotes"
extends Node
Container for one or more adjacent citation nodes.
Properties
children: Citation[]
Info from the ecosystem.
data?: Data from Node.data
Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.
position?: Position from Node.position
Node type.
type: "citations"
extends Parent
AST node created by remark-directive .
Properties
Attributes declared on the directive.
attributes: Record<string, (string | undefined)>
List of children.
children: RootContent[] from Parent.children
Info from the ecosystem.
data?: Data from Parent.data
The directive name without its leading colons.
name: string
Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.
position?: Position from Parent.position
Node type.
type: ("containerDirective" | "leafDirective" | "textDirective")
import
imported from @types/mdast
import
imported from @types/mdast
import
imported from @types/mdast
import
imported from @types/mdast
import
imported from @types/mdast
import
imported from @types/unist
extends Node
Inline node that references an item in the source citation array.
Properties
citationIndex: number
Info from the ecosystem.
data?: Data from Node.data
Position of a node in a source document.

Nodes that are generated (not in the original source document) must not have a position.
position?: Position from Node.position
Text replaced by a position-based citation.
text?: string
Node type.
type: "citation"

Except where otherwise noted, content on this site is licensed under MIT License.