remark-lint-blockquote-indentation

remark-lint-blockquote-indentation

Warn when blockquotes are indented too much or too little.

Options: number or 'consistent', default: 'consistent'.

'consistent' detects the first used indentation and will warn when other blockquotes use a different indentation.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-consistent	'consistent'
remark-preset-lint-markdown-style-guide	2

Example

valid.md

When configured with 2.

In

> Hello

Paragraph.

> World

Out

No messages.

valid.md

When configured with 4.

In

>   Hello

Paragraph.

>   World

Out

No messages.

invalid.md

In

>  Hello

Paragraph.

>   World

Paragraph.

> World

Out

5:3: Remove 1 space between blockquote and content
9:3: Add 1 space between blockquote and content

Install

npm install remark-lint-blockquote-indentation

Usage

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

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-blockquote-indentation",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-blockquote-indentation 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-blockquote-indentation'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer