Project: syntax-tree/mdast-util-to-string

Package: mdast-util-to-string@1.1.0

  1. Dependencies: 0·Dependents: 150
  2. mdast utility to get the plain text content of a node
  1. markdown 133
  2. util 118
  3. utility 114
  4. unist 110
  5. mdast 81
  6. mdast-util 24
  7. node 21
  8. serialize 9
  9. string 4


Build Coverage Downloads Size Sponsors Backers Chat

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



npm install mdast-util-to-string


var unified = require('unified')
var parse = require('remark-parse')
var toString = require('mdast-util-to-string')

var tree = unified()
  .parse('Some _emphasis_, **importance**, and `code`.')

console.log(toString(tree)) // => 'Some emphasis, importance, and code.'



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.


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.


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.


MIT © Titus Wormer