unified

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

Package: mdast-util-to-string@1.1.0

  1. Dependencies: 0·Dependents: 147
  2. mdast utility to get the plain text content of a node
  1. markdown 111
  2. util 107
  3. utility 105
  4. unist 97
  5. mdast 72
  6. node 21
  7. mdast-util 15
  8. serialize 8
  9. string 4

mdast-util-to-string

Build Coverage Downloads Size Sponsors Backers Chat

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

Install

npm:

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.

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.

License

MIT © Titus Wormer