dmfrancisco / mdast-util-to-string

Utility to get the plain text content of a node

mdast-util-to-string

Get the plain text content of an MDAST node.

Installation

npm:

npm install mdast-util-to-string

Usage

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. If no value is found, the algorithm checks the children of node and joins them (without spaces or newlines).

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

Related

• nlcst-to-string — Get text content in NLCST
• hast-util-to-string — Get text content in HAST
• hast-util-from-string — Set text content in HAST

Contribute

See contribute.md in syntax-tree/mdast for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer