Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

@nousdev/parser-md

Markdown and GitHub Flavored Markdown (GFM) parser that converts .md files into the Nous Document Model.

Installation

npm install @nousdev/parser-md

Usage

import { createMarkdownParser } from '@nousdev/parser-md';

const parser = createMarkdownParser();

const doc = await parser.parse('# Hello\n\nSome **bold** text.', {
  filePath: 'docs/intro.md',
  format: 'md',
});

Lower-level conversion

import { mdastToNDM, extractText } from '@nousdev/parser-md';

// Convert a remark MDAST tree directly to NDM nodes
const ndmNodes = mdastToNDM(mdastTree);

// Extract plain text from an inline node array
const plain = extractText(inlineNodes);

API

  • createMarkdownParser(options?) -- returns a NousParser for .md and .markdown files with GFM and frontmatter support
  • mdastToNDM(tree) -- convert a remark MDAST syntax tree into NDM block nodes
  • extractText(nodes) -- extract plain text content from inline node arrays

Parser capabilities

  • YAML frontmatter extraction
  • GFM extensions (tables, strikethrough, task lists, autolinks)
  • Heading hierarchy with source location tracking
  • Code blocks with language and metadata annotations

Built on unified with remark-parse, remark-gfm, and remark-frontmatter.

License

MIT