Skip to content

Interface: MarkdownSectionSourceNode<T> ​

Defined in: core/dist/ast/domain/markdown-section-source-node.d.ts:10

Passive AST node extracting a specific Markdown heading section from a document (md.section).

Parses the Markdown document at path relative to the host repository root and extracts the text under heading up to the next heading of equal or higher depth.

Extends ​

Extended by ​

Type Parameters ​

Type ParameterDefault typeDescription
TunknownResolved section content type.

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
__dataType?readonlyBivariantCallback<[data: T], void>Phantom type brand preserving the resolved content type T.BaseSourceASTNode.__dataTypecore/dist/ast/base/base-source-ast-node.d.ts:17
headingreadonlystringTarget heading title to extract.-core/dist/ast/domain/markdown-section-source-node.d.ts:14
idreadonlystringLogical identifier of the source descriptor.BaseSourceASTNode.idcore/dist/ast/base/base-source-ast-node.d.ts:15
pathreadonlystringHost-root-relative path to the Markdown file.-core/dist/ast/domain/markdown-section-source-node.d.ts:12
typereadonly"markdown:section"Unique string-literal discriminant of the source node.BaseSourceASTNode.typecore/dist/ast/base/base-source-ast-node.d.ts:13

Released under the MIT License.