remark-lint-no-paragraph-content-indent

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

npm:

npm install remark-lint-no-paragraph-content-indent

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:

 var remark = require('remark')
 var report = require('vfile-reporter')
 
 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-paragraph-content-indent'))
   .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