mdast-util-to-string

mdast utility to get the plain text content of a node.

Install

npm install mdast-util-to-string

Use

var unified = require('unified')
var parse = require('remark-parse')
var toString = require('mdast-util-to-string')
 
var tree = unified()
  .use(parse)
  .parse('Some _emphasis_, **importance**, and `code`.')
 
console.log(toString(tree)) // => 'Some emphasis, importance, and code.'

API

`toString(node)`

Get the text content of a node.

The algorithm checks value of node, then alt, and finally title. If no value is found, the algorithm checks the children of node and joins them (without spaces or newlines). If the given node is in fact a list of nodes, serializes them.

This is not a markdown to plain-text library. Use strip-markdown for that.

Security

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.

nlcst-to-string — Get text content in nlcst
hast-util-to-string — Get text content in hast
hast-util-to-text — Get text content in hast according to the innerText algorithm
hast-util-from-string — Set text content in hast

Contribute

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.

npm