<internal>

Classes

Class	Description
Processor	-
VFile	-
VFileMessage	Message.

Interfaces

Interface	Description
Alternative	Node with a fallback.
Association	Internal relation from one node to another.
BlockContentMap	Registry of all mdast nodes that can occur where BlockContent is expected.
Blockquote	Markdown block quote.
BlockquoteData	Info associated with mdast block quote nodes by the ecosystem.
Break	Markdown break.
BreakData	Info associated with mdast break nodes by the ecosystem.
CallSite	-
Code	Markdown code (flow) (block).
CodeData	Info associated with mdast code (flow) (block) nodes by the ecosystem.
Comment	HTML comment.
CommentData	Info associated with hast comments by the ecosystem.
CompileResultMap	Interface of known results from compilers.
Data	Info associated with nodes by the ecosystem.
Data	Interface of known data that can be supported by all plugins.
Data	Info associated with mdast nodes by the ecosystem.
Data	Info associated with hast nodes by the ecosystem.
DataMap	This map registers the type of the data key of a VFile.
Definition	Markdown definition.
DefinitionContentMap	Registry of all mdast nodes that can occur where DefinitionContent is expected.
DefinitionData	Info associated with mdast definition nodes by the ecosystem.
Delete	Markdown GFM delete (strikethrough).
DeleteData	Info associated with mdast GFM delete nodes by the ecosystem.
Doctype	HTML document type.
DoctypeData	Info associated with hast doctypes by the ecosystem.
Element	HTML element.
ElementContentMap	Registry of all hast nodes that can occur as children of Element.
ElementData	Info associated with hast elements by the ecosystem.
Emphasis	Markdown emphasis.
EmphasisData	Info associated with mdast emphasis nodes by the ecosystem.
FootnoteDefinition	Markdown GFM footnote definition.
FootnoteDefinitionData	Info associated with mdast GFM footnote definition nodes by the ecosystem.
FootnoteReference	Markdown GFM footnote reference.
FootnoteReferenceData	Info associated with mdast GFM footnote reference nodes by the ecosystem.
Heading	Markdown heading.
HeadingData	Info associated with mdast heading nodes by the ecosystem.
Html	Markdown HTML.
HtmlData	Info associated with mdast HTML nodes by the ecosystem.
Image	Markdown image.
ImageData	Info associated with mdast image nodes by the ecosystem.
ImageReference	Markdown image reference.
ImageReferenceData	Info associated with mdast image reference nodes by the ecosystem.
InlineCode	Markdown code (text) (inline).
InlineCodeData	Info associated with mdast code (text) (inline) nodes by the ecosystem.
Link	Markdown link.
LinkData	Info associated with mdast link nodes by the ecosystem.
LinkReference	Markdown link reference.
LinkReferenceData	Info associated with mdast link reference nodes by the ecosystem.
List	Markdown list.
ListData	Info associated with mdast list nodes by the ecosystem.
ListItem	Markdown list item.
ListItemData	Info associated with mdast list item nodes by the ecosystem.
Literal	Abstract hast node that contains the smallest possible value.
Literal	Abstract mdast node that contains the smallest possible value.
Map	Raw source map.
Node	Abstract unist node.
Node	Abstract mdast node.
Node	Abstract hast node.
Options	Configuration.
Paragraph	Markdown paragraph.
ParagraphData	Info associated with mdast paragraph nodes by the ecosystem.
Parent	Abstract mdast node that contains other mdast nodes (children).
Parent	Abstract hast node that contains other hast nodes (children).
PhrasingContentMap	Registry of all mdast nodes that can occur where PhrasingContent is expected.
Point	One place in a source file.
Position	Position of a node in a source document.
Properties	Info associated with an element.
Reference	Marker that is associated to another node.
Resource	Reference to resource.
Root	Document fragment or a whole document.
Root	Document fragment or a whole document.
RootContentMap	Registry of all mdast nodes that can occur as children of Root.
RootContentMap	Registry of all hast nodes that can occur as children of Root.
RootData	Info associated with mdast root nodes by the ecosystem.
RootData	Info associated with hast root nodes by the ecosystem.
Settings	Interface of known extra options, that can be supported by parser and compilers.
Strong	Markdown strong.
StrongData	Info associated with mdast strong nodes by the ecosystem.
Table	Markdown GFM table.
TableCell	Markdown GFM table cell.
TableCellData	Info associated with mdast GFM table cell nodes by the ecosystem.
TableData	Info associated with mdast GFM table nodes by the ecosystem.
TableRow	Markdown GFM table row.
TableRowData	Info associated with mdast GFM table row nodes by the ecosystem.
Text	HTML character data (plain text).
Text	Markdown text.
TextData	Info associated with hast texts by the ecosystem.
TextData	Info associated with mdast text nodes by the ecosystem.
ThematicBreak	Markdown thematic break (horizontal rule).
ThematicBreakData	Info associated with mdast thematic break nodes by the ecosystem.
Yaml	Markdown YAML.
YamlData	Info associated with mdast YAML nodes by the ecosystem.

Type Aliases

Type Alias	Description
AlignType	How phrasing content is aligned ([CSSTEXT]).
BlockContent	Union of registered mdast nodes that can occur where block content is expected.
Callable	-
Compatible	Things that can be passed to the constructor.
Compiler	A compiler handles the compiling of a syntax tree to something else (in most cases, text) (TypeScript type).
CompileResultMap	-
CompileResults	Acceptable results from compilers.
Data	Custom info.
DefinitionContent	Union of registered mdast nodes that can occur where definition content is expected.
ElementContent	Union of registered hast nodes that can occur in Element.
Extract	Extract from T those types that are assignable to U
ExtractFunction	-
Middleware	Ware.
Node	-
Node	-
NodeLike	-
NodeLike	-
Options	Configuration.
Parser	A parser handles the parsing of text to a syntax tree.
Partial	Make all properties in T optional
PhrasingContent	Union of registered mdast nodes that can occur where phrasing content is expected.
Pipeline	Pipeline.
Pluggable	Union of the different ways to add plugins and settings.
PluggableList	List of plugins and presets.
Plugin	Single plugin.
PluginTuple	Tuple of a plugin and its configuration.
Point	-
Position	-
Preset	Sharable configuration.
ProcessCallback	Callback called when the process is done.
Record	Construct a type with a set of properties K of type T
ReferenceType	Explicitness of a reference.
Required	Make all properties in T required
RootContent	Union of registered mdast nodes that can occur in Root.
RootContent	Union of registered hast nodes that can occur in Root.
Run	Call all middleware.
RunCallback	Callback called when transformers are done.
Settings	-
TransformCallback	Callback passed to transforms.
Transformer	Transformers handle syntax trees and files.
Use	Add middleware.
UsePlugin	Create a processor based on the input/output of a plugin.
Value	Contents of the file.
Value	-
VFileWithOutput	Type to generate a VFile corresponding to a compiler result.

Variables

Variable	Description
CallableInstance	-