unified

Project: syntax-tree/mdast-util-compact

Package: mdast-util-compact@2.0.1

  1. Dependencies: 1·Dependents: 9
  2. mdast utility to make a tree compact
  1. util 107
  2. utility 105
  3. unist 97
  4. mdast 72
  5. tree 40
  6. node 21
  7. mdast-util 15

mdast-util-compact

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to make trees compact: collapse text nodes (when possible) and blockquotes (in commonmark mode).

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[, commonmark])

Walk the tree and collapse nodes. Combines adjacent texts (but not when they represent entities or escapes). If commonmark is true, 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.

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