<internal>

Index

Namespaces

NamespaceDescription
../../node_modules/@types/unist-
../../node_modules/unified-
../../node_modules/vfile-
../../node_modules/vfile-message/lib-

Classes

ClassDescription
Processor-
VFile-
VFileMessageMessage.

Interfaces

InterfaceDescription
AlternativeNode with a fallback.
AssociationInternal relation from one node to another.
BlockContentMapRegistry of all mdast nodes that can occur where BlockContent is expected.
BlockquoteMarkdown block quote.
BlockquoteDataInfo associated with mdast block quote nodes by the ecosystem.
BreakMarkdown break.
BreakDataInfo associated with mdast break nodes by the ecosystem.
CallSite-
CodeMarkdown code (flow) (block).
CodeDataInfo associated with mdast code (flow) (block) nodes by the ecosystem.
CommentHTML comment.
CommentDataInfo associated with hast comments by the ecosystem.
DataInterface of known data that can be supported by all plugins.
DataInfo associated with mdast nodes by the ecosystem.
DataInfo associated with hast nodes by the ecosystem.
DataMapThis map registers the type of the data key of a VFile.
DefinitionMarkdown definition.
DefinitionContentMapRegistry of all mdast nodes that can occur where DefinitionContent is expected.
DefinitionDataInfo associated with mdast definition nodes by the ecosystem.
DeleteMarkdown GFM delete (strikethrough).
DeleteDataInfo associated with mdast GFM delete nodes by the ecosystem.
DoctypeHTML document type.
DoctypeDataInfo associated with hast doctypes by the ecosystem.
ElementHTML element.
ElementContentMapRegistry of all hast nodes that can occur as children of Element.
ElementDataInfo associated with hast elements by the ecosystem.
EmphasisMarkdown emphasis.
EmphasisDataInfo associated with mdast emphasis nodes by the ecosystem.
FootnoteDefinitionMarkdown GFM footnote definition.
FootnoteDefinitionDataInfo associated with mdast GFM footnote definition nodes by the ecosystem.
FootnoteReferenceMarkdown GFM footnote reference.
FootnoteReferenceDataInfo associated with mdast GFM footnote reference nodes by the ecosystem.
HeadingMarkdown heading.
HeadingDataInfo associated with mdast heading nodes by the ecosystem.
HtmlMarkdown HTML.
HtmlDataInfo associated with mdast HTML nodes by the ecosystem.
ImageMarkdown image.
ImageDataInfo associated with mdast image nodes by the ecosystem.
ImageReferenceMarkdown image reference.
ImageReferenceDataInfo associated with mdast image reference nodes by the ecosystem.
InlineCodeMarkdown code (text) (inline).
InlineCodeDataInfo associated with mdast code (text) (inline) nodes by the ecosystem.
LinkMarkdown link.
LinkDataInfo associated with mdast link nodes by the ecosystem.
LinkReferenceMarkdown link reference.
LinkReferenceDataInfo associated with mdast link reference nodes by the ecosystem.
ListMarkdown list.
ListDataInfo associated with mdast list nodes by the ecosystem.
ListItemMarkdown list item.
ListItemDataInfo associated with mdast list item nodes by the ecosystem.
LiteralAbstract hast node that contains the smallest possible value.
LiteralAbstract mdast node that contains the smallest possible value.
MapRaw source map.
NodeAbstract unist node.
NodeAbstract mdast node.
NodeAbstract hast node.
OptionsConfiguration.
ParagraphMarkdown paragraph.
ParagraphDataInfo associated with mdast paragraph nodes by the ecosystem.
ParentAbstract mdast node that contains other mdast nodes (children).
ParentAbstract hast node that contains other hast nodes (children).
PhrasingContentMapRegistry of all mdast nodes that can occur where PhrasingContent is expected.
PointOne place in a source file.
PositionPosition of a node in a source document.
PropertiesInfo associated with an element.
ReferenceMarker that is associated to another node.
ResourceReference to resource.
RootDocument fragment or a whole document.
RootDocument fragment or a whole document.
RootContentMapRegistry of all mdast nodes that can occur as children of Root.
RootContentMapRegistry of all hast nodes that can occur as children of Root.
RootDataInfo associated with mdast root nodes by the ecosystem.
RootDataInfo associated with hast root nodes by the ecosystem.
SettingsInterface of known extra options, that can be supported by parser and compilers.
StrongMarkdown strong.
StrongDataInfo associated with mdast strong nodes by the ecosystem.
TableMarkdown GFM table.
TableCellMarkdown GFM table cell.
TableCellDataInfo associated with mdast GFM table cell nodes by the ecosystem.
TableDataInfo associated with mdast GFM table nodes by the ecosystem.
TableRowMarkdown GFM table row.
TableRowDataInfo associated with mdast GFM table row nodes by the ecosystem.
TextHTML character data (plain text).
TextMarkdown text.
TextDataInfo associated with hast texts by the ecosystem.
TextDataInfo associated with mdast text nodes by the ecosystem.
ThematicBreakMarkdown thematic break (horizontal rule).
ThematicBreakDataInfo associated with mdast thematic break nodes by the ecosystem.
YamlMarkdown YAML.
YamlDataInfo associated with mdast YAML nodes by the ecosystem.

Type Aliases

Type aliasDescription
AlignTypeHow phrasing content is aligned ([CSSTEXT]).
ArrayBufferLike-
BlockContentUnion of registered mdast nodes that can occur where block content is expected.
Callable-
CompatibleThings that can be passed to the constructor.
CompilerA compiler handles the compiling of a syntax tree to something else (in most cases, text) (TypeScript type).
CompileResultMap-
CompileResultsAcceptable results from compilers.
DataCustom info.
DefinitionContentUnion of registered mdast nodes that can occur where definition content is expected.
ElementContentUnion of registered hast nodes that can occur in Element.
ExtractExtract from T those types that are assignable to U
ExtractFunction-
MiddlewareWare.
Node-
Node-
NodeLike-
NodeLike-
OptionsConfiguration.
ParserA parser handles the parsing of text to a syntax tree.
PartialMake all properties in T optional
PhrasingContentUnion of registered mdast nodes that can occur where phrasing content is expected.
PipelinePipeline.
PluggableUnion of the different ways to add plugins and settings.
PluggableListList of plugins and presets.
PluginSingle plugin.
Point-
Position-
PresetSharable configuration.
ProcessCallbackCallback called when the process is done.
RecordConstruct a type with a set of properties K of type T
ReferenceTypeExplicitness of a reference.
RequiredMake all properties in T required
RootContentUnion of registered mdast nodes that can occur in Root.
RootContentUnion of registered hast nodes that can occur in Root.
RunCall all middleware.
RunCallbackCallback called when transformers are done.
Settings-
TransformCallbackCallback passed to transforms.
TransformerTransformers handle syntax trees and files.
UseAdd middleware.
UsePluginCreate a processor based on the input/output of a plugin.
ValueContents of the file.
Value-
VFileWithOutputType to generate a VFile corresponding to a compiler result.

Variables

VariableDescription
CallableInstance-

References

PluginTuple

Re-exports PluginTuple