unified

Project: remarkjs/remark-lint

Package: remark-lint-no-blockquote-without-marker@4.0.0

  1. Dependencies: 5·Dependents: 16
  2. remark-lint rule to warn when blank lines without markers (>) are found in a block quote
  1. remark 191
  2. lint 76
  3. rule 71
  4. remark-lint-rule 64
  5. marker 12
  6. blockquote 2

remark-lint-no-blockquote-without-marker

Build Coverage Downloads Size Sponsors Backers Chat

Warn when blank lines without > (greater than) markers are found in a block quote.

Fix

remark-stringify adds markers to every line in a block quote.

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

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Example

ok.md
In
> Foo…
> …bar…
> …baz.
Out

No messages.

ok-tabs.md
In

Note: » represents a tab.

>»Foo…
>»…bar…
>»…baz.
Out

No messages.

not-ok.md
In
> Foo…
…bar…
> …baz.
Out
2:1: Missing marker in block quote
not-ok-tabs.md
In

Note: » represents a tab.

>»Foo…
»…bar…
…baz.
Out
2:1: Missing marker in block quote
3:1: Missing marker in block quote

Install

npm:

npm install remark-lint-no-blockquote-without-marker

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-blockquote-without-marker",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-blockquote-without-marker readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-blockquote-without-marker'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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.

License

MIT © Titus Wormer