mdast-util-from-markdown
Advanced tools
The mdast-util-from-markdown package is a utility to parse Markdown and convert it into a Markdown Abstract Syntax Tree (MDAST). It allows developers to work with the tree structure to manipulate, inspect, or transform Markdown content programmatically.
Parsing Markdown to MDAST
This feature allows you to parse a Markdown string and produce an MDAST. The MDAST can then be manipulated or inspected as needed.
import { fromMarkdown } from 'mdast-util-from-markdown';
const mdast = fromMarkdown('# Hello world');Using plugins to extend parsing capabilities
This feature enables the use of plugins to extend the parsing capabilities of the utility. For example, using the 'micromark-extension-gfm' plugin to support GitHub Flavored Markdown (GFM) features like task lists.
import { fromMarkdown } from 'mdast-util-from-markdown';
import gfm from 'micromark-extension-gfm';
const mdast = fromMarkdown('# Hello world\n\n- [ ] task list item', {extensions: [gfm()]});Remark-parse is a plugin for the remark processor that parses Markdown into an MDAST. It is part of the unified ecosystem and is similar to mdast-util-from-markdown but is typically used as part of the remark ecosystem.
Markdown-it is a Markdown parser with a focus on speed and extensibility. It can be used to parse Markdown into a syntax tree, which is similar to MDAST but with its own structure. It differs from mdast-util-from-markdown in that it is a full parser and renderer, not just a utility for producing an AST.
Marked is a Markdown parser and compiler that is designed for speed. It produces an abstract syntax tree that can be used similarly to MDAST, but it is not directly compatible with the unified ecosystem like mdast-util-from-markdown is.
mdast utility that turns markdown into a syntax tree.
This package is a utility that takes markdown input and turns it into an mdast syntax tree.
This utility uses micromark, which turns markdown into tokens,
and then turns those tokens into nodes.
This package is used inside remark-parse, which focusses on
making it easier to transform content by abstracting these internals away.
If you want to handle syntax trees manually, use this.
When you just want to turn markdown into HTML, use micromark
instead.
For an easier time processing content, use the remark ecosystem instead.
You can combine this package with other packages to add syntax extensions to
markdown.
Notable examples that deeply integrate with this package are
mdast-util-gfm,
mdast-util-mdx,
mdast-util-frontmatter,
mdast-util-math, and
mdast-util-directive.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-from-markdown
In Deno with esm.sh:
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@2'
In browsers with esm.sh:
<script type="module">
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@2?bundle'
</script>
Say we have the following markdown file example.md:
## Hello, *World*!
…and our module example.js looks as follows:
import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
const doc = await fs.readFile('example.md')
const tree = fromMarkdown(doc)
console.log(tree)
…now running node example.js 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 identifier fromMarkdown.
There is no default export.
The export map supports the development condition.
Run node --conditions development example.js to get instrumented dev code.
Without this condition, production code is loaded.
fromMarkdown(value[, encoding][, options])Turn markdown into a syntax tree.
(value: Value, encoding: Encoding, options?: Options) => Root(value: Value, options?: Options) => Rootvalue (Value)
— markdown to parseencoding (Encoding, default: 'utf8')
— character encoding for when value is
Uint8Arrayoptions (Options, optional)
— configurationmdast tree (Root).
CompileContextmdast compiler context (TypeScript type).
stack (Array<Node>)
— stack of nodestokenStack (Array<[Token, OnEnterError | undefined]>)
— stack of tokensdata (CompileData)
— info passed around; key/value storebuffer (() => undefined)
— capture some of the output dataresume (() => string)
— stop capturing and access the output dataenter ((node: Node, token: Token, onError?: OnEnterError) => undefined)
— enter a nodeexit ((token: Token, onError?: OnExitError) => undefined)
— exit a nodesliceSerialize ((token: Token, expandTabs?: boolean) => string)
— get the string value of a tokenconfig (Required<Extension>)
— configurationCompileDataInterface of tracked data (TypeScript type).
interface CompileData { /* see code */ }
When working on extensions that use more data, extend the corresponding interface to register their types:
declare module 'mdast-util-from-markdown' {
interface CompileData {
// Register a new field.
mathFlowInside?: boolean | undefined
}
}
EncodingEncodings supported by the Uint8Array class (TypeScript type).
See micromark for more info.
type Encoding = 'utf8' | /* … */
ExtensionChange how markdown tokens from micromark are turned into mdast (TypeScript type).
canContainEols (Array<string>, optional)
— token types where line endings are usedenter (Record<string, Handle>, optional)
— opening handlesexit (Record<string, Handle>, optional)
— closing handlestransforms (Array<Transform>, optional)
— tree transformsHandleHandle a token (TypeScript type).
this (CompileContext)
— contexttoken (Token)
— current tokenNothing (undefined).
OnEnterErrorHandle the case where the right token is open, but it is closed (by the
left token) or because we reached the end of the document (TypeScript type).
this (CompileContext)
— contextleft (Token or undefined)
— left tokenright (Token)
— right tokenNothing (undefined).
OnExitErrorHandle the case where the right token is open but it is closed by
exiting the left token (TypeScript type).
this (CompileContext)
— contextleft (Token)
— left tokenright (Token)
— right tokenNothing (undefined).
OptionsConfiguration (TypeScript type).
extensions (Array<MicromarkExtension>, optional)
— micromark extensions to change how markdown is parsedmdastExtensions (Array<Extension | Array<Extension>>,
optional)
— extensions for this utility to change how tokens are turned into a treeTokenToken from micromark (TypeScript type).
type Token = { /* … */ }
TransformExtra transform, to change the AST afterwards (TypeScript type).
tree (Root)
— tree to transformNew tree (Root) or nothing (in which case the current tree is used).
ValueContents of the file (TypeScript type).
See micromark for more info.
type Value = Uint8Array | string
syntax-tree/mdast-util-directive
— directivessyntax-tree/mdast-util-frontmatter
— frontmatter (YAML, TOML, more)syntax-tree/mdast-util-gfm
— GFMsyntax-tree/mdast-util-gfm-autolink-literal
— GFM autolink literalssyntax-tree/mdast-util-gfm-footnote
— GFM footnotessyntax-tree/mdast-util-gfm-strikethrough
— GFM strikethroughsyntax-tree/mdast-util-gfm-table
— GFM tablessyntax-tree/mdast-util-gfm-task-list-item
— GFM task list itemssyntax-tree/mdast-util-math
— mathsyntax-tree/mdast-util-mdx
— MDXsyntax-tree/mdast-util-mdx-expression
— MDX expressionssyntax-tree/mdast-util-mdx-jsx
— MDX JSXsyntax-tree/mdast-util-mdxjs-esm
— MDX ESMMarkdown is parsed according to CommonMark. Extensions can add support for other syntax. If you’re interested in extending markdown, more information is available in micromark’s readme.
The syntax tree is mdast.
This package is fully typed with TypeScript.
It exports the additional types CompileContext,
CompileData,
Encoding,
Extension,
Handle,
OnEnterError,
OnExitError,
Options,
Token,
Transform, and
Value.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
mdast-util-from-markdown@^2, compatible with Node.js 16.
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.
syntax-tree/mdast-util-to-markdown
— serialize mdast as markdownmicromark/micromark
— parse markdownremarkjs/remark
— process markdownSee 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.
FAQs
mdast utility to parse markdown
The npm package mdast-util-from-markdown receives a total of 7,436,876 weekly downloads. As such, mdast-util-from-markdown popularity was classified as popular.
We found that mdast-util-from-markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.