mirror of https://github.com/remarkjs/remark-lint.git synced 2024-10-27 11:47:47 +03:00

History

Titus Wormer 65e25393a7 Move URLs to HTTPS		2018-11-22 12:19:09 +01:00
..
index.js	Use `unist-util-stringify-position` where possible	2018-06-04 14:42:14 +02:00
package.json	Move URLs to HTTPS	2018-11-22 12:19:09 +01:00
readme.md	Move URLs to HTTPS	2018-11-22 12:19:09 +01:00

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

`valid.md`

In

## Alpha

### Bravo

## Charlie

### Bravo

### Delta

#### Bravo

#### Echo

##### Bravo

Out

No messages.

`invalid.md`

In

## Foxtrot

### Golf

### Golf

Out

5:1-5:9: Do not use headings with similar content per section (3:1)

Install

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

Usage

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));
   });