@zkochan/mdast-util-to-string v0.1.0

mdast-util-to-string

remark utility to get the plain text content of an mdast node.

Installation

npm:

npm install mdast-util-to-string

mdast-util-to-string is also available for duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

/*
 * Dependencies.
 */

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

/*
 * AST.
 */

var ast = remark.parse('Some *emphasis*, **strongness**, and `code`.');

toString(ast);
// 'Some emphasis, strongness, 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).

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

Parameters:

• node (Node).

Returns: string — text representation of node.

License

MIT © Titus Wormer