Skip to content

@paraharness/markdown ​

Variables ​

VariableDescription
markdownExecutorsDefault frozen @paraharness/markdown runtime executor registry slice (markdownExecutors).
mdFrozen @paraharness/markdown builder namespace (md.*).

Functions ​

FunctionDescription
createMarkdownExecutorsCreates the @paraharness/markdown runtime executor registry slice.
createMdFrontmatterBuilderBuilds a MdFrontmatterSourceBuilder<T> for md.frontmatter(pathOrGlob).
createMdGlobalRulesBuilderBuilds a MdFrontmatterSourceBuilder<readonly GlobalRule[]> for md.globalRules(glob).
createMdScopedRuleBuilderBuilds a MdFrontmatterSourceBuilder<ScopedRule> for md.scopedRule(path).
createMdScopedRulesBuilderBuilds a MdFrontmatterSourceBuilder<readonly ScopedRule[]> for md.scopedRules(glob).
createMdSectionBuilderBuilds a MdSectionSourceBuilder<T> for md.section(path, heading).
createMdSkillBuilderBuilds a MdFrontmatterSourceBuilder<SkillNode<THandle>> for md.skill(path).
createMdSkillsBuilderBuilds a MdFrontmatterSourceBuilder<readonly SkillNode<THandle>[]> for md.skills(glob).
executeMarkdownFrontmatterSourceExecutes a MarkdownFrontmatterSourceNode<T> against the immutable host repository root (SPEC.md §3.4, §4.5).
executeMarkdownSectionSourceExecutes a MarkdownSectionSourceNode<T> against the immutable host repository root (SPEC.md §4.5).
extractMarkdownHeadingSectionExtracts the Markdown body text under a specific ATX heading up to the next heading of equal or higher rank.
parseMarkdownFrontmatterParses leading YAML frontmatter and body content from a raw Markdown string via mdast and yaml.

Interfaces ​

InterfaceDescription
MarkdownFrontmatterSourceNodePassive AST node loading frontmatter-annotated rules or skills from Markdown files (md.*).
MarkdownSectionSourceNodePassive AST node extracting a specific Markdown heading section from a document (md.section).
MdFrontmatterSourceBuilderFluent builder and passive AST descriptor for Markdown frontmatter sources (md.*).
MdNamespacePublic builder namespace contract for @paraharness/markdown (md.*).
MdSectionSourceBuilderFluent builder and passive AST descriptor for Markdown heading section sources (md.section).
ParsedMarkdownDocumentParsed representation of a Markdown document with optional YAML frontmatter.

Released under the MIT License.