unified

Project: remarkjs/remark-lint

Package: remark-lint-blockquote-indentation@2.0.1

  1. Dependencies: 6·Dependents: 20
  2. remark-lint rule to warn when block quotes are either indented too much or too little
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. indent 8
  6. blockquote 2

remark-lint-blockquote-indentation

Build Coverage Downloads Size Sponsors Backers Chat

Warn when block quotes are indented too much or too little.

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

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

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide2

Example

ok.md

When configured with 2.

In
> Hello

Paragraph.

> World
Out

No messages.

ok.md

When configured with 4.

In
>   Hello

Paragraph.

>   World
Out

No messages.

not-ok.md
In
>  Hello

Paragraph.

>   World

Paragraph.

> World
Out
5:3: Remove 1 space between block quote and content
9:3: Add 1 space between block quote and content

Install

npm:

npm install remark-lint-blockquote-indentation

Use

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))
   })

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