mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
.. | ||
index.js | ||
package.json | ||
readme.md |
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.
![ image]() text
![ image reference][] text
[![ ][text]][text]
Out
1:1: Expected no indentation in paragraph content
4:1: Expected no indentation in paragraph content
5:3: Expected no indentation in paragraph content
8:5: Expected no indentation in paragraph content
11:3: Expected no indentation in paragraph content
14:1: Expected no indentation in paragraph content
17:5: Expected no indentation in paragraph content
19:1: Expected no indentation in paragraph content
21:1: Expected no indentation in paragraph content
23:2: 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.