mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
282d27606d
This commit rewrites most of the documentation per rule and preset, `remark-lint` itself, and `unified-lint-rule`. * Better and more readable automatic examples * Check and update all rule descriptions * Use middot (·) and line-feed (␊) for relevant examples * Unify descriptions of `'consistent`' * Add some more docs where needed Closes GH-158. |
||
|---|---|---|
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
remark-lint-no-heading-content-indent
Warn when a heading’s content is indented.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-recommended |
Example
valid.md
In
Note: · represents a space.
#·Foo
## Bar·##
##·Baz
Setext headings are not affected.
Baz
===
Out
No messages.
invalid.md
In
Note: · represents a space.
#··Foo
## Bar··##
##··Baz
Out
1:4: Remove 1 space before this heading’s content
3:7: Remove 1 space after this heading’s content
5:7: Remove 1 space before this heading’s content
empty-heading.md
In
Note: · represents a space.
#··
Out
No messages.
tight.md
In
Note: · represents a space.
In pedantic mode, headings without spacing can also be detected:
##No spacing left, too much right··##
Out
3:3: Add 1 space before this heading’s content
3:34: Remove 1 space after this heading’s content
Install
npm install remark-lint-no-heading-content-indent
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-no-heading-content-indent",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-no-heading-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-heading-content-indent'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});