Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

@nousdev/parser-mdx

MDX parser that converts .mdx files (Markdown + JSX) into the Nous Document Model with support for embedded component invocations.

Installation

npm install @nousdev/parser-mdx

Usage

import { createMdxParser } from '@nousdev/parser-mdx';

const parser = createMdxParser();

const doc = await parser.parse(
  `# API Reference

<EndpointCard method="GET" path="/users" />

Returns a list of users.`,
  { filePath: 'api.mdx', format: 'mdx' },
);

API

  • createMdxParser(options?) -- returns a NousParser for .mdx files; JSX elements become ComponentInvocationNode entries in the NDM tree

Parser capabilities

  • All standard Markdown and GFM features (tables, strikethrough, task lists)
  • YAML frontmatter extraction
  • JSX component invocations parsed as ComponentInvocationNode
  • Component prop extraction and nested children support
  • Built on unified with remark-parse, remark-mdx, remark-gfm, and remark-frontmatter

License

MIT