mdast-util-mdx-expression

Contents

• What is this?
• When to use this
• Install
• Use
• API

*   [`mdxExpressionFromMarkdown`](#mdxexpressionfrommarkdown)
*   [`mdxExpressionToMarkdown`](#mdxexpressiontomarkdown)

• Syntax tree

*   [Nodes](#nodes)
*   [Content model](#content-model)

• Types
• Compatibility
• Related
• Contribute
• License

What is this?

When to use this

Install

npm install mdast-util-mdx-expression

import {mdxExpressionFromMarkdown, mdxExpressionToMarkdown} from 'https://esm.sh/mdast-util-mdx-expression@1'

<script type="module">
  import {mdxExpressionFromMarkdown, mdxExpressionToMarkdown} from 'https://esm.sh/mdast-util-mdx-expression@1?bundle'
</script>

Use

{
  a + 1
}

b {true}.

import fs from 'node:fs/promises'
import * as acorn from 'acorn'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toMarkdown} from 'mdast-util-to-markdown'
import {mdxExpression} from 'micromark-extension-mdx-expression'
import {mdxExpressionFromMarkdown, mdxExpressionToMarkdown} from 'mdast-util-mdx-expression'

const doc = await fs.readFile('example.mdx')

const tree = fromMarkdown(doc, {
  extensions: [mdxExpression({acorn, addResult: true})],
  mdastExtensions: [mdxExpressionFromMarkdown]
})

console.log(tree)

const out = toMarkdown(tree, {extensions: [mdxExpressionToMarkdown]})

console.log(out)

{
  type: 'root',
  children: [
    {
      type: 'mdxFlowExpression',
      value: '\na + 1\n',
      data: {
        estree: {
          type: 'Program',
          body: [
            {
              type: 'ExpressionStatement',
              expression: {
                type: 'BinaryExpression',
                left: {type: 'Identifier', name: 'a'},
                operator: '+',
                right: {type: 'Literal', value: 1, raw: '1'}
              }
            }
          ],
          sourceType: 'module'
        }
      }
    },
    {
      type: 'paragraph',
      children: [
        {type: 'text', value: 'b '},
        {
          type: 'mdxTextExpression',
          value: 'true',
          data: {
            estree: {
              type: 'Program',
              body: [
                {
                  type: 'ExpressionStatement',
                  expression: {type: 'Literal', value: true, raw: 'true'}
                }
              ],
              sourceType: 'module'
            }
          }
        },
        {type: 'text', value: '.'}
      ]
    }
  ]
}

{
  a + 1
}

b {true}.

API

mdxExpressionFromMarkdown

mdxExpressionToMarkdown

Syntax tree

interface MDXFlowExpression <: Literal {
  type: "mdxFlowExpression"
}

{
  1 + 1
}

{type: 'mdxFlowExpression', value: '\n1 + 1\n'}

interface MDXTextExpression <: Literal {
  type: "mdxTextExpression"
}

a {1 + 1} b.

{type: 'mdxTextExpression', value: '1 + 1'}

type FlowContentMdxExpression = MDXFlowExpression | FlowContent

type PhrasingContentMdxExpression = MDXTextExpression | PhrasingContent

/**
 * @typedef {import('mdast-util-mdx-expression')}
 */

import {visit} from 'unist-util-visit'

/** @type {import('mdast').Root} */
const tree = getMdastNodeSomeHow()

visit(tree, (node) => {
  // `node` can now be an expression node.
})

Compatibility

Related

• remarkjs/remark-mdxremark-mdx

— remark plugin to support MDX

• syntax-tree/mdast-util-mdxmdast-util-mdx

— mdast utility to support MDX

• micromark/micromark-extension-mdx-expressionextension

— micromark extension to parse MDX expressions

Contribute

License