unified

Project: remarkjs/remark-lint

Package: remark-lint-no-duplicate-headings-in-section@2.0.1

  1. Dependencies: 6·Dependents: 11
  2. remark-lint rule to warn on duplicate headings in a section
  1. remark 188
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. heading 26
  6. duplicate 4
  7. section 2

remark-lint-no-duplicate-headings-in-section

Build Coverage Downloads Size Sponsors Backers Chat

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.

License

MIT © Titus Wormer