@origints/markdown

Markdown parsing with GitHub Flavored Markdown support, YAML frontmatter extraction, and HTML conversion.

Installation

npm install @origints/markdown @origints/core

Features

• GFM (GitHub Flavored Markdown) support
• YAML frontmatter extraction
• Source position tracking for all nodes
• Type-safe navigation and extraction
• Convert to HTML
• Tables, task lists, and footnotes

Usage with Planner

Extract content

import { Planner, loadFile, run } from '@origints/core'
import { parseMarkdown } from '@origints/markdown'

const plan = new Planner()
  .in(loadFile('README.md'))
  .mapIn(parseMarkdown())
  .emit((out, $) => out
    .add('title', $.select('heading').text())
  )
  .compile()

const result = await run(plan, { readFile, registry })

Extract collections

.emit((out, $) => out
  .add('headings', $.selectAll('heading', node => node.text()))
)

Children extraction

.emit((out, $) => out
  .add('blocks', $.children(node => node.text()))
)

Frontmatter

.emit((out, $) => out
  .add('frontmatter', $.select('yaml').text())
)

Standalone usage

import { parseMarkdownImpl, MarkdownNode } from '@origints/markdown'

const node = parseMarkdownImpl.execute(markdownString) as MarkdownNode

const heading = node.select('heading')
if (heading.ok) console.log(heading.value.text())

// Attribute selectors
node.select('heading[depth=1]')
node.select('code[lang="typescript"]')

HTML conversion

import { parseMarkdownImpl, toHtml } from '@origints/markdown'

const node = parseMarkdownImpl.execute('# Hello\n\nWorld') as MarkdownNode
const html = toHtml(node)

Frontmatter extraction

import { parseMarkdownImpl, extractFrontmatter } from '@origints/markdown'

const node = parseMarkdownImpl.execute(markdownWithFrontmatter) as MarkdownNode
const frontmatter = extractFrontmatter(node)
if (frontmatter) console.log(frontmatter.title)

API

Export	Description
parseMarkdown(options?)	Transform AST for Planner.mapIn()
parseMarkdownImpl	Sync transform implementation
parseMarkdownAsyncImpl	Async transform implementation
registerMarkdownTransforms(registry)	Register Markdown transforms
MarkdownNode	Navigable wrapper with selector support
toHtml(node)	Convert to HTML
extractFrontmatter(node)	Extract YAML frontmatter

License

MIT