Package Exports

remark-lint-no-missing-blank-lines

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-missing-blank-lines) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-no-missing-blank-lines

Warn when missing blank lines before block content (and frontmatter content).

This rule can be configured to allow tight list items without blank lines between their contents by passing {exceptTightLists: true} (default: false).

Fix

remark-stringify always uses one blank line between blocks if possible, or two lines when needed. The style of the list items persists.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is not included in any default preset

Example

`ok.md`

In

# Foo

## Bar

- Paragraph

  + List.

Paragraph.

Out

No messages.

`not-ok.md`

In

# Foo
## Bar

- Paragraph
  + List.

Paragraph.

Out

2:1-2:7: Missing blank line before block node
5:3-5:10: Missing blank line before block node

`tight.md`

When configured with { exceptTightLists: true }.

In

# Foo
## Bar

- Paragraph
  + List.

Paragraph.

Out

2:1-2:7: Missing blank line before block node

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-no-missing-blank-lines

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

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-missing-blank-lines",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-missing-blank-lines readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoMissingBlankLines from 'remark-lint-no-missing-blank-lines'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoMissingBlankLines)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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.