unified

Project: remarkjs/remark-lint

Package: remark-lint-no-paragraph-content-indent@4.1.0

  1. Dependents: 8
  2. remark-lint rule to warn when the content in paragraphs are indented
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. content 20
  6. indent 8
  7. paragraph 4

remark-lint-no-paragraph-content-indent

Build Coverage Downloads Size Sponsors Backers Chat

Warn when the content in paragraphs is indented.

Presets

This rule is not included in any default preset

Example

ok.md
In
Alpha

Bravo
Charlie.
**Delta**.

*   Echo
    Foxtrot.

> Golf
> Hotel.

`india()`
juliett.

-   `kilo()`
    lima.

-   `mike()` - november.

![image]() text

![image reference][] text

[![][text]][text]
Out

No messages.

not-ok.md
In

Note: · represents a space.

·Alpha

Bravo
·Charlie.

*   Delta
    ·Echo.

> Foxtrot
> ·Golf.

`hotel()`
·india.

-   `juliett()`
    ·kilo.

·![lima]() mike

* november
oscar
  ·papa.
Out
1:2: Expected no indentation in paragraph content
4:2: Expected no indentation in paragraph content
7:6: Expected no indentation in paragraph content
10:4: Expected no indentation in paragraph content
13:2: Expected no indentation in paragraph content
16:6: Expected no indentation in paragraph content
18:2: Expected no indentation in paragraph content
22:4: Expected no indentation in paragraph content

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-paragraph-content-indent

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

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-paragraph-content-indent",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-paragraph-content-indent readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoParagraphContentIndent from 'remark-lint-no-paragraph-content-indent'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoParagraphContentIndent)
   .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.

License

MIT © Titus Wormer