$ gnpm install mdast-util-from-markdown
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 14.14+ and 16.0+), install with npm:
npm install mdast-util-from-markdown
In Deno with esm.sh
:
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@1'
In browsers with esm.sh
:
<script type="module">
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@1?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) => Root
value
(Value
)
— markdown to parseencoding
(Encoding
, default: 'utf8'
)
— character encoding for when value
is
Buffer
options
(Options
, optional)
— configurationmdast tree (Root
).
CompileContext
mdast compiler context (TypeScript type).
stack
(Array<Node>
)
— stack of nodestokenStack
(Array<[Token, OnEnterError | undefined]>
)
— stack of tokensgetData
((key: string) => unknown
)
— get data from the key/value store (see CompileData
)setData
((key: string, value?: unknown) => void
)
— set data into the key/value store (see CompileData
)buffer
(() => void
)
— capture some of the output dataresume
(() => string
)
— stop capturing and access the output dataenter
((node: Node, token: Token, onError?: OnEnterError) => Node
)
— enter a tokenexit
((token: Token, onError?: OnExitError) => Node
)
— exit a tokensliceSerialize
((token: Token, expandTabs?: boolean) => string
)
— get the string value of a tokenconfig
(Required<Extension>
)
— configurationCompileData
Interface 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
}
}
Encoding
Encodings supported by the Buffer
class (TypeScript type).
See micromark
for more info.
type Encoding = 'utf8' | /* … */
Extension
Change 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 transformsHandle
Handle a token (TypeScript type).
this
(CompileContext
)
— contexttoken
(Token
)
— current tokenNothing (void
).
OnEnterError
Handle 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 (void
).
OnExitError
Handle 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 (void
).
Options
Configuration (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 treeToken
Token from micromark (TypeScript type).
See micromark
for more info.
type Token = { /* … */ }
Transform
Extra 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).
Value
Contents of the file (TypeScript type).
See micromark
for more info.
type Value = string | Uint8Array
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 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.
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.
Copyright 2013 - present © cnpmjs.org | Home |