rsuite-theme/_node_modules/mdast-util-compact/readme.md

The suite theme for pagurian

# mdast-util-compact [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]

Make an [MDAST][] tree compact: collapse text nodes (when possible),
and blockquotes (in commonmark mode).

## Installation

[npm][]:

```bash
npm install mdast-util-compact
```

## Usage

```javascript
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:

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

## API

### `compact(tree[, commonmark])`

Visit the tree and collapse nodes.  Combines adjacent text nodes (but
not when they represent entities or escapes).  If `commonmark` is `true`,
collapses `blockquote` nodes.

Handles positional information properly.

###### Returns

The given `tree`.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[travis-badge]: https://img.shields.io/travis/syntax-tree/mdast-util-compact.svg

[travis]: https://travis-ci.org/syntax-tree/mdast-util-compact

[codecov-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-compact.svg

[codecov]: https://codecov.io/github/syntax-tree/mdast-util-compact

[npm]: https://docs.npmjs.com/cli/install

[license]: LICENSE

[author]: http://wooorm.com

[mdast]: https://github.com/syntax-tree/mdast