mdast-util-to-string
Advanced tools
Package description
The mdast-util-to-string package is a utility to extract plain text strings from an MDAST (Markdown Abstract Syntax Tree) node. It is commonly used when working with markdown processing or AST manipulation to get the string representation of a node without any markdown syntax.
Extracting string from MDAST node
This feature allows you to pass an MDAST node to the `toString` function and receive a plain text string in return. It's useful for extracting readable text from markdown content.
const toString = require('mdast-util-to-string');
const mdast = {
type: 'paragraph',
children: [{type: 'text', value: 'Hello, world!'}]
};
const text = toString(mdast);
console.log(text); // 'Hello, world!'Similar to mdast-util-to-string, hast-util-to-text is a utility for converting HAST (Hypertext Abstract Syntax Tree) nodes to plain text strings. While mdast-util-to-string works with markdown, hast-util-to-text is used for HTML content.
This package is similar in that it also operates on AST nodes, specifically UNIST nodes, to stringify the position of a node. It's different from mdast-util-to-string as it focuses on the position rather than extracting the text content.
Remark-stringify is part of the remark ecosystem and is used to serialize markdown. It is similar to mdast-util-to-string in that it deals with markdown content, but it focuses on converting the entire MDAST back to a markdown string, rather than extracting plain text.
Readme
mdast utility to get the text content of a node.
This package is a tiny utility that gets the textual content of a node.
This utility is useful when you have a node, say a heading, and want to get the text inside it.
This package does not serialize markdown, that’s what
mdast-util-to-markdown does.
Similar packages, hast-util-to-string and
hast-util-to-text, do the same but on hast.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-to-string
In Deno with esm.sh:
import {toString} from 'https://esm.sh/mdast-util-to-string@4'
In browsers with esm.sh:
<script type="module">
import {toString} from 'https://esm.sh/mdast-util-to-string@4?bundle'
</script>
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toString} from 'mdast-util-to-string'
const tree = fromMarkdown('Some _emphasis_, **importance**, and `code`.')
console.log(toString(tree)) // => 'Some emphasis, importance, and code.'
This package exports the identifier toString.
There is no default export.
toString(value[, options])Get the text content of a node or list of nodes.
Prefers the node’s plain-text fields, otherwise serializes its children, and if the given value is an array, serialize the nodes in it.
Serialized value (string).
OptionsConfiguration (TypeScript type).
includeImageAlt (boolean, default: true)
— whether to use alt for imagesincludeHtml (boolean, default: true)
— whether to use value of HTMLThis package is fully typed with TypeScript.
It exports the additional type Options.
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-to-string@^4,
compatible with Node.js 16.
Use of mdast-util-to-string does not involve hast, user content, or
change the tree, so there are no openings for cross-site scripting (XSS)
attacks.
hast-util-to-string
— get text content in hasthast-util-to-text
— get text content in hast according to the innerText algorithmSee 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 get the plain text content of a node
The npm package mdast-util-to-string receives a total of 10,410,310 weekly downloads. As such, mdast-util-to-string popularity was classified as popular.
We found that mdast-util-to-string 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
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.