npm install mdxld

---
title: Hello World
author: Jane Doe
---
 
# Hello World
 
Content here...

---
$type: Article
$id: https://example.com/posts/hello-world
$context: https://schema.org
title: Hello World
author:
  $type: Person
  name: Jane Doe
  url: https://example.com/authors/jane
publishedAt: 2024-01-15
---
 
# Hello World
 
Content here with **semantic** meaning.

interface MDXLDDocument {
  /** Frontmatter data with LD properties */
  data: MDXLDData
  /** MDX content body */
  content: string
  /** Optional document identifier */
  id?: string
  /** Optional document type */
  type?: string
}

import { parse } from 'mdxld'
 
const doc = parse(`---
$type: BlogPost
title: My First Post
---
 
# My First Post
 
Hello, world!
`)
 
console.log(doc.data.$type) // 'BlogPost'
console.log(doc.data.title) // 'My First Post'
console.log(doc.content)    // '# My First Post\n\nHello, world!'

import { stringify } from 'mdxld'
 
const mdx = stringify({
  data: {
    $type: 'Article',
    title: 'Hello World',
  },
  content: '# Hello World\n\nContent here.',
})
 
console.log(mdx)
// ---
// $type: Article
// title: Hello World
// ---
//
// # Hello World
//
// Content here.

import { parse, toAst } from 'mdxld'
 
const doc = parse(content)
const ast = toAst(doc)
 
// Traverse the AST
for (const node of ast.children) {
  if (node.type === 'heading') {
    console.log(`H${node.depth}: ${node.children?.[0]?.value}`)
  }
}

import { toAst, fromAst } from 'mdxld/ast'
 
const ast = toAst(doc)
// Manipulate the AST...
const newDoc = fromAst(ast)

import { createValidator } from 'mdxld/validate'
import { type } from 'arktype'
 
const validateArticle = createValidator(type({
  '$type': '"Article"',
  'title': 'string',
  'author': 'string',
}))
 
const result = validateArticle(doc)
if (result.success) {
  console.log('Valid article:', result.data)
} else {
  console.error('Validation errors:', result.errors)
}

import { compile } from 'mdxld/compile'
 
const result = await compile(doc, {
  jsx: true,
  remarkPlugins: [],
  rehypePlugins: [],
})

import type {
  MDXLDDocument,
  MDXLDData,
  MDXLDAst,
  MDXLDAstNode,
  LDProperties,
} from 'mdxld/types'

import type { MDXLDDocument } from 'mdxld'
 
function processDocument(doc: MDXLDDocument) {
  // Full autocomplete and type checking
  if (doc.data.$type === 'Article') {
    // Handle articles
  }
}