Registry / serialization / mdast-util-from-markdown

mdast-util-from-markdown

library2.0.3jsnpmunverified

mdast-util-from-markdown is a foundational utility in the syntax-tree ecosystem, designed to parse Markdown input into an mdast (Markdown Abstract Syntax Tree) syntax tree. It leverages the micromark tokenizer internally and transforms its output into a tree structure. The current stable version is 2.0.3, with frequent patch and minor releases, while major versions like 2.0.0 introduce significant breaking changes such as the shift to ESM-only and a minimum Node.js 16 requirement. This package provides a lower-level API for direct AST manipulation, making it suitable for developers who need fine-grained control over the parsing process or wish to integrate custom syntax extensions like GFM, MDX, Math, or Frontmatter. It is distinct from micromark (which focuses on direct HTML output) and remark-parse (which offers a higher-level, more abstracted content processing experience within the remark ecosystem).

serialization data

npm install mdast-util-from-markdown

github ↗package ↗

INSTALL

IMPORT

SIG · MDAST-UTIL-FROM-MA

mdast-util-from-markdown

serializationjavascriptv2.0.3

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

fromMarkdown

✓ import { fromMarkdown } from 'mdast-util-from-markdown'

✗ const fromMarkdown = require('mdast-util-from-markdown')

mdast-util-from-markdown has been ESM-only since v2.0.0, requiring Node.js 16+. CommonJS `require` is not supported for direct imports.

Extension

✓ import type { Extension } from 'mdast-util-from-markdown'

✗ import { Extension } from 'mdast-util-from-markdown'

This symbol represents a TypeScript type definition for extending Markdown parsing, not a runtime value. It should be imported as a type.

Options

✓ import type { Options } from 'mdast-util-from-markdown'

✗ import { Options } from 'mdast-util-from-markdown'

This symbol represents a TypeScript type definition for the parser configuration, not a runtime value. It should be imported as a type.

This quickstart demonstrates how to asynchronously read a Markdown file and parse its content into an mdast syntax tree using the `fromMarkdown` utility.

import fs from 'node:fs/promises' import {fromMarkdown} from 'mdast-util-from-markdown' async function parseExample() { // Assume 'example.md' contains '## Hello, *World*!' const doc = await fs.readFile('example.md', 'utf8') const tree = fromMarkdown(doc) console.log(JSON.stringify(tree, null, 2)) // Expected output: // { // "type": "root", // "children": [ // { // "type": "heading", // "depth": 2, // "children": [ // { "type": "text", "value": "Hello, " }, // { "type": "emphasis", "children": [{ "type": "text", "value": "World" }] }, // { "type": "text", "value": "!" } // ] // } // ] // } } parseExample().catch(console.error)

Debug

Known issues

breakingVersion 2.0.0 of `mdast-util-from-markdown` requires Node.js version 16 or higher. Older Node.js versions are no longer supported.

fix

Upgrade your Node.js environment to version 16 or newer. Use nvm or your preferred Node.js version manager.

affects: >=2.0.0

breakingThe package became ESM-only (ECMAScript Modules) in version 2.0.0. CommonJS `require()` statements are no longer supported for direct imports.

fix

Migrate your codebase to use ES module `import` syntax. Ensure your `package.json` specifies `"type": "module"` or use `.mjs` file extensions. For mixed CJS/ESM projects, consider dynamic `import()`.

affects: >=2.0.0

breakingVersion 2.0.0 updated its internal `micromark` dependency to v4, which changed how buffers are handled. Input values or encodings that previously accepted Node.js `Buffer` objects now expect `Uint8Array`s.

fix

If you are passing raw buffers, ensure they are converted to `Uint8Array` instances before passing them to `fromMarkdown`. For example, `new Uint8Array(myBuffer)`.

affects: >=2.0.0

breakingThe internal API for creating custom extensions changed significantly in v2.0.0, specifically replacing getter/setters for some properties with direct assignments.

fix

If you have custom markdown extensions that interact deeply with `mdast-util-from-markdown`'s internals, you will need to update them according to the `micromark@4` and `mdast-util-from-markdown@2` migration guides. Review `Extension` and `CompileContext` types for changes.

affects: >=2.0.0

gotchaThis utility is for building an mdast syntax tree. If your goal is simply to convert Markdown to HTML, `micromark` is a more direct choice. If you want a higher-level content processing pipeline, consider the `remark` ecosystem and `remark-parse`.

fix

Choose the right tool for the job: `micromark` for direct HTML, `remark` for plugin-based content transformation, `mdast-util-from-markdown` for direct AST manipulation.

affects: >=1.0.0

Errors

Common errors & fixes

ReferenceError: require is not defined

Attempting to use CommonJS `require()` in an environment that expects ES Modules.

fix

Update your import statements to use `import { fromMarkdown } from 'mdast-util-from-markdown'` and ensure your project is configured for ESM (e.g., `"type": "module"` in `package.json`).

TypeError: Expected Uint8Array, got Buffer

Passing a Node.js `Buffer` object to `fromMarkdown` for the `value` or `encoding` argument after upgrading to v2.x, which expects `Uint8Array`.

fix

Convert your `Buffer` instances to `Uint8Array` before passing them. Example: `fromMarkdown(new Uint8Array(myBuffer))`.

Error: Cannot find package 'mdast-util-from-markdown' imported from ...

Using an outdated Node.js version (prior to 16) with `mdast-util-from-markdown` v2.x, which is ESM-only and requires Node.js 16+.

fix

Upgrade your Node.js version to 16 or newer. Also, verify your project's `package.json` correctly specifies `"type": "module"` if you're using explicit ESM in your files.

TypeError: fromMarkdown is not a function

Incorrectly attempting to use a default import for `fromMarkdown`, or a typo in the named import.

fix

Ensure you are using a named import: `import { fromMarkdown } from 'mdast-util-from-markdown'`. The package has no default export.

Upgrade

Version history

2.0.3latest on npm

Audit

Dependencies

micromarkrequiredCore internal dependency for tokenization; major version updates in micromark often necessitate breaking changes in mdast-util-from-markdown.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/syntax-tree/mdast-util-from-markdown ↗

packagehttps://www.npmjs.com/package/mdast-util-from-markdown ↗