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-duplicate-headings-in-section
Warn when duplicate headings are found, but only when on the same level, “in” the same section.
Presets
This rule is not included in any default preset
Example
ok.md
In
## Alpha
### Bravo
## Charlie
### Bravo
### Delta
#### Bravo
#### Echo
##### Bravo
Out
No messages.
not-ok.md
In
## Foxtrot
### Golf
### Golf
Out
5:1-5:9: Do not use headings with similar content per section (3:1)
Install
npm:
npm install remark-lint-no-duplicate-headings-in-section
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-duplicate-headings-in-section",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-duplicate-headings-in-section 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-duplicate-headings-in-section'))
.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.