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

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)

not-ok-tolerant-heading-increment.md

In

# Alpha

#### Bravo

###### Charlie

#### Bravo

###### Delta

Out

7:1-7:11: Do not use headings with similar content per section (3:1)

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

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

This package exports no identifiers. The default export is remarkLintNoDuplicateHeadingsInSection.

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoDuplicateHeadingsInSection from 'remark-lint-no-duplicate-headings-in-section'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoDuplicateHeadingsInSection)
   .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