mdast-util-to-string

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

Similar packages

Other packages similar to mdast-util-to-string

hast-util-to-text

Similar to mdast-util-to-string, hast-util-to-text is a utility for converting HAST (Hypertext Abstract Syntax Tree) nodes to plain text strings. While mdast-util-to-string works with markdown, hast-util-to-text is used for HTML content.

unist-util-stringify-position

This package is similar in that it also operates on AST nodes, specifically UNIST nodes, to stringify the position of a node. It's different from mdast-util-to-string as it focuses on the position rather than extracting the text content.

remark-stringify

Remark-stringify is part of the remark ecosystem and is used to serialize markdown. It is similar to mdast-util-to-string in that it deals with markdown content, but it focuses on converting the entire MDAST back to a markdown string, rather than extracting plain text.