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-heading-increment
Warn when headings increment with more than 1 level at a time.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
Example
valid.md
In
# Alpha
## Bravo
Out
No messages.
invalid.md
In
# Charlie
### Delta
Out
3:1-3:10: Heading levels should increment by one level at a time
Install
npm install remark-lint-heading-increment
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-heading-increment",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-heading-increment 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-heading-increment'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});