Miss any of our Open RFC calls?Watch the recordings here! »

mdast-util-compact

3.0.0 • Public • Published

mdast-util-compact

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to make trees compact: collapse adjacent text nodes and blockquotes.

Install

npm:

npm install mdast-util-compact

Use

var u = require('unist-builder')
var compact = require('mdast-util-compact')
 
var tree = u('strong', [u('text', 'alpha'), u('text', ' '), u('text', 'bravo')])
 
compact(tree)
 
console.log(tree)

Yields:

{ type: 'strong',
  children: [ { type: 'text', value: 'alpha bravo' } ] }

API

compact(tree)

Walk the tree and collapse nodes. Combines adjacent texts and collapses blockquotes.

Handles positional information properly.

Returns

The given tree.

Security

Use of mdast-util-compact does not involve hast or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

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

Install

npm i mdast-util-compact

DownloadsWeekly Downloads

2,231,676

Version

3.0.0

License

MIT

Unpacked Size

7.14 kB

Total Files

4

Last publish

Collaborators

  • avatar
  • avatar