Warn when duplicate headings are found.
Presets
This rule is included in the following presets:
Example
ok.md
In
# Foo
## Bar
Out
No messages.
not-ok.md
In
# Foo
## Foo
## [Foo](http://foo.com/bar)
Out
3:1-3:7: Do not use headings with similar content (1:1)
5:1-5:29: Do not use headings with similar content (3:1)
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-lint-no-duplicate-headings
This package exports no identifiers.
The default export is remarkLintNoDuplicateHeadings
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-duplicate-headings",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-duplicate-headings readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoDuplicateHeadings from 'remark-lint-no-duplicate-headings'
remark()
.use(remarkLint)
+ .use(remarkLintNoDuplicateHeadings)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(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