What is remark-squeeze-paragraphs?
The remark-squeeze-paragraphs npm package is a plugin for the remark processor that removes empty paragraphs from Markdown content. It helps in cleaning up the Markdown by eliminating unnecessary whitespace and empty lines, making the content more compact and readable.
What are remark-squeeze-paragraphs's main functionalities?
Remove Empty Paragraphs
This feature removes empty paragraphs from the given Markdown content. The code sample demonstrates how to use the remark-squeeze-paragraphs plugin with the remark processor to clean up the Markdown by eliminating unnecessary empty lines.
const remark = require('remark');
const squeezeParagraphs = require('remark-squeeze-paragraphs');
const markdown = `
# Title
This is a paragraph.
Another paragraph.
`;
remark()
.use(squeezeParagraphs)
.process(markdown, function (err, file) {
if (err) throw err;
console.log(String(file));
});
Other packages similar to remark-squeeze-paragraphs
remark-lint-no-empty-sections
The remark-lint-no-empty-sections package is a remark-lint rule that checks for and warns about empty sections in Markdown content. Unlike remark-squeeze-paragraphs, which removes empty paragraphs, this package is used for linting purposes to ensure that sections are not left empty.
remark-lint-no-consecutive-blank-lines
The remark-lint-no-consecutive-blank-lines package is another remark-lint rule that ensures there are no consecutive blank lines in Markdown content. While it does not remove the lines, it helps maintain a clean structure by warning about multiple blank lines, similar to how remark-squeeze-paragraphs removes them.
remark-remove-comments
The remark-remove-comments package is a plugin for remark that removes HTML comments from Markdown content. While it focuses on removing comments rather than empty paragraphs, it serves a similar purpose of cleaning up the Markdown content.
Remove empty (or white-space only) paragraphs with remark.
Installation
npm:
npm install remark-squeeze-paragraphs
Usage
var remark = require('remark')
var stripBadges = require('remark-strip-badges')
var squeezeParagraphs = require('remark-squeeze-paragraphs')
remark()
.use(stripBadges)
.processSync('![](https://img.shields.io/)\n\ntext')
.toString()
remark()
.use(stripBadges)
.use(squeezeParagraphs)
.processSync('![](https://img.shields.io/)\n\ntext')
.toString()
API
Transform the tree to remove empty paragraphs.
Related
Contribute
See contributing.md
in remarkjs/remark
for ways to get
started.
This organisation has a Code of Conduct. By interacting with this
repository, organisation, or community you agree to abide by its terms.
License
MIT © Eugene Sharygin