remark-squeeze-paragraphs

remark plugin to remove empty (or white space only) paragraphs.

What is this?
When should I use this?
Install
Use
API
- unified().use(remarkSqueezeParagraphs)
Types
Compatibility
Security
Related
Contribute
License

What is this?

This package is a unified (remark) plugin to remove empty paragraphs.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that transforms mdast.

When should I use this?

This project is mostly useful when you’re using other plugins that remove things from the AST (such as remark-strip-badges). You can then use this plugin afterwards to clean stray empty paragraphs.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-squeeze-paragraphs

In Deno with esm.sh:

import remarkSqueezeParagraphs from 'https://esm.sh/remark-squeeze-paragraphs@5'

In browsers with esm.sh:

<script type="module">
  import remarkSqueezeParagraphs from 'https://esm.sh/remark-squeeze-paragraphs@5?bundle'
</script>

Use

import {remark} from 'remark'
import remarkStripBadges from 'remark-strip-badges'
import remarkSqueezeParagraphs from 'remark-squeeze-paragraphs'

main()

async function main() {
  console.log(
    (
      await remark()
        .use(remarkStripBadges)
        .process('![](https://img.shields.io/)\n\ntext')
    ).toString()
  )
  // => '\n\ntext\n'

  console.log(
    (
      await remark()
        .use(remarkStripBadges)
        .use(remarkSqueezeParagraphs)
        .process('![](https://img.shields.io/)\n\ntext')
    ).toString()
  )
  // => 'text\n'
}

API

This package exports no identifiers. The default export is remarkSqueezeParagraphs.

`unified().use(remarkSqueezeParagraphs)`

Remove empty (or white space only) paragraphs. There are no options.

Types

This package is fully typed with TypeScript. There are no extra exported types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with unified version 3+ and remark version 4+.

Security

Use of remark-squeeze-paragraphs does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

mdast-squeeze-paragraphs — mdast utility with similar functionality

Contribute

See contributing.md in remarkjs/.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.

isabella232 / remark-squeeze-paragraphs Goto Github PK