unified

Project: syntax-tree/mdast-util-math

Package: mdast-util-math@2.0.1

  1. Dependents: 0
  2. mdast extension to parse and serialize math
  1. markdown 155
  2. util 145
  3. utility 141
  4. unist 132
  5. mdast 86
  6. mdast-util 31
  7. markup 19
  8. math 6
  9. latex 6
  10. tex 5
  11. katex 4

mdast-util-math

Build Coverage Downloads Size Sponsors Backers Chat

mdast extensions to parse and serialize math ($C_L$).

Contents

What is this?

This package contains two extensions that add support for math syntax in markdown to mdast. These extensions plug into mdast-util-from-markdown (to support parsing math in markdown into a syntax tree) and mdast-util-to-markdown (to support serializing math in syntax trees to markdown).

When to use this

This project is useful when you want to support math in markdown. Extending markdown with a syntax extension makes the markdown less portable. LaTeX equations are also quite hard. But this mechanism works well when you want authors, that have some LaTeX experience, to be able to embed rich diagrams of math in scientific text.

You can use these extensions when you are working with mdast-util-from-markdown and mdast-util-to-markdown already.

When working with mdast-util-from-markdown, you must combine this package with micromark-extension-math.

When you don’t need a syntax tree, you can use micromark directly with micromark-extension-math.

All these packages are used remark-math, which focusses on making it easier to transform content by abstracting these internals away.

This utility adds fields on nodes so that the utility responsible for turning mdast (markdown) nodes into hast (HTML) nodes, mdast-util-to-hast, turns text (inline) math nodes into <span class="math math-inline">…</span> and flow (block) math nodes into <div class="math math-display">…</div>.

Install

This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

npm install mdast-util-math

In Deno with esm.sh:

import {mathFromMarkdown, mathToMarkdown} from 'https://esm.sh/mdast-util-math@2'

In browsers with esm.sh:

<script type="module">
  import {mathFromMarkdown, mathToMarkdown} from 'https://esm.sh/mdast-util-math@2?bundle'
</script>

Use

Say our document example.md contains:

Lift($L$) can be determined by Lift Coefficient ($C_L$) like the following equation.

$$
L = \frac{1}{2} \rho v^2 S C_L
$$

…and our module example.js looks as follows:

import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toMarkdown} from 'mdast-util-to-markdown'
import {math} from 'micromark-extension-math'
import {mathFromMarkdown, mathToMarkdown} from 'mdast-util-math'

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

const tree = fromMarkdown(doc, {
  extensions: [math()],
  mdastExtensions: [mathFromMarkdown()]
})

console.log(tree)

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

console.log(out)

…now running node example.js yields (positional info and data removed for brevity):

{
  type: 'root',
  children: [
    {
      type: 'paragraph',
      children: [
        {type: 'text', value: 'Lift('},
        {type: 'inlineMath', value: 'L', data: {/* … */}},
        {type: 'text', value: ') can be determined by Lift Coefficient ('},
        {type: 'inlineMath', e: 'C_L', data: {/* … */}},
        {type: 'text', value: ') like the following equation.'}
      ]
    },
    {type: 'math', meta: null, value: 'L = \\frac{1}{2} \\rho v^2 S C_L', data: {/* … */}}
  ]
}
Lift($L$) can be determined by Lift Coefficient ($C_L$) like the following equation.

$$
L = \frac{1}{2} \rho v^2 S C_L
$$

API

This package exports the identifiers mathFromMarkdown and mathToMarkdown. There is no default export.

mathFromMarkdown()

Create an extension for mdast-util-from-markdown.

Returns

Extension for mdast-util-from-markdown (FromMarkdownExtension).

mathToMarkdown(options?)

Create an extension for mdast-util-to-markdown.

Parameters
Returns

Extension for mdast-util-to-markdown (ToMarkdownExtension).

InlineMath

Math (text) (TypeScript type).

Type
import type {Literal} from 'mdast'

interface InlineMath extends Literal {
  type: 'inlineMath'
}

Math

Math (flow) (TypeScript type).

Type
import type {Literal} from 'mdast'

interface Math extends Literal {
  type: 'math'
  meta?: string | undefined | null
}

ToOptions

Configuration (TypeScript type).

Fields

HTML

This plugin integrates with mdast-util-to-hast. When mdast is turned into hast the math nodes are turned into <span class="math math-inline">…</span> and <div class="math math-display">…</div> elements.

Syntax

See Syntax in micromark-extension-frontmatter.

Syntax tree

The following interfaces are added to mdast by this utility.

Nodes

Math

interface Math <: Literal {
  type: "code"
  meta: string?
}

Math (Literal) represents a block of math, such as LaTeX mathematical expressions.

Math can be used where flow content is expected. Its content is represented by its value field.

This node relates to the phrasing content concept InlineMath.

A meta field can be present. It represents custom information relating to the node.

For example, the following markdown:

$$
L = \frac{1}{2} \rho v^2 S C_L
$$

Yields:

{
  type: 'math',
  meta: null,
  value: 'L = \\frac{1}{2} \\rho v^2 S C_L',
  data: {/* … */}
}

InlineMath

interface InlineMath <: Literal {
  type: "inlineMath"
}

InlineMath (Literal) represents a fragment of computer code, such as a file name, computer program, or anything a computer could parse.

InlineMath can be used where phrasing content is expected. Its content is represented by its value field.

This node relates to the flow content concept Math.

For example, the following markdown:

$L$

Yields:

{type: 'inlineMath', value: 'L', data: {/* … */}}

Content model

FlowContent (math)

type FlowContentMath = Math | FlowContent

PhrasingContent (math)

type PhrasingMath = InlineMath | PhrasingContent

Types

This package is fully typed with TypeScript. It exports the additional types InlineMath, Math, and ToOptions.

It also registers the node types with @types/mdast. If you’re working with the syntax tree, make sure to import this utility somewhere in your types, as that registers the new node types in the tree.

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

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

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

visit(tree, (node) => {
  // `node` can now be one of the nodes for math.
})

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with mdast-util-from-markdown version 1+ and mdast-util-to-markdown version 1+.

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer