mdast-util-from-markdown
Advanced tools
Package description
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.
Readme
mdast utility to parse markdown.
npm:
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:
var fs = require('fs')
var fromMarkdown = require('mdast-util-from-markdown')
var doc = fs.readFileSync('example.md')
var tree = fromMarkdown(doc)
console.log(tree)
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: '!'}
]
}
]
}
fromMarkdown(doc[, encoding][, options])Parse markdown to a mdast tree.
docValue to parse (string or Buffer).
encodingCharacter encoding to understand doc as when it’s a
Buffer (string, default: 'utf8').
options.extensionsArray of syntax extensions (Array.<MicromarkSyntaxExtension>, default: []).
Passed to micromark as extensions.
options.mdastExtensionsArray of mdast extensions (Array.<MdastExtension>, default: []).
Root.
syntax-tree/mdast-util-footnote
— parse footnotessyntax-tree/mdast-util-frontmatter
— parse frontmatter (YAML, TOML, more)syntax-tree/mdast-util-gfm
— parse GFMsyntax-tree/mdast-util-gfm-autolink-literal
— parse GFM autolink literalssyntax-tree/mdast-util-gfm-strikethrough
— parse GFM strikethroughsyntax-tree/mdast-util-gfm-table
— parse GFM tablessyntax-tree/mdast-util-gfm-task-list-item
— parse GFM task list itemsAs 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.
micromark/micromark
— the smallest commonmark-compliant markdown parser that existsremarkjs/remark
— markdown processor powered by pluginssyntax-tree/mdast-util-to-markdown
— serialize mdast to 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 6,594,515 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.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.