Project: syntax-tree/mdast-util-from-markdown

Package: mdast-util-from-markdown@1.2.0

  1. Dependents: 50
  2. mdast utility to parse markdown
  1. util 144
  2. utility 140
  3. markdown 131
  4. unist 128
  5. mdast 84
  6. tree 41
  7. ast 33
  8. mdast-util 31
  9. syntax 27
  10. parse 22
  11. markup 19


Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to parse markdown.

When to use this

Use this if you want to use micromark but need an AST. Use remark instead, which includes both to provide a nice interface and hundreds of plugins.


This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.


npm install mdast-util-from-markdown


Say we have the following markdown file, example.md:

## Hello, *World*!

And our script, example.js, looks as follows:

import fs from 'node:fs'
import {fromMarkdown} from 'mdast-util-from-markdown'

const doc = fs.readFileSync('example.md')

const tree = fromMarkdown(doc)


Now, running node example yields (positional info removed for brevity):

  type: 'root',
  children: [
      type: 'heading',
      depth: 2,
      children: [
        {type: 'text', value: 'Hello, '},
          type: 'emphasis',
          children: [{type: 'text', value: 'World'}]
        {type: 'text', value: '!'}


This package exports the following identifier: fromMarkdown. There is no default export.

The export map supports the endorsed development condition. Run node --conditions development module.js to get instrumented dev code. Without this condition, production code is loaded.

fromMarkdown(doc[, encoding][, options])

Parse markdown to a mdast tree.


Value to parse (string or Buffer).


Character encoding to understand doc as when it’s a Buffer (string, default: 'utf8').


Array of syntax extensions (Array<MicromarkSyntaxExtension>, default: []). Passed to micromark as extensions.


Array of mdast extensions (Array<MdastExtension>, default: []).



List of extensions


As markdown is sometimes used for HTML, and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of mdast-util-from-markdown can also be unsafe. When going to HTML, use this utility in combination with hast-util-sanitize to make the tree safe.


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.


MIT © Titus Wormer