remark-lint/packages/remark-lint-heading-increment

remark-lint-heading-increment

Warn when headings increment with more than 1 level at a time.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide

Example

ok.md

In

# Alpha

## Bravo

Out

No messages.

not-ok.md

In

# Charlie

### Delta

Out

3:1-3:10: Heading levels should increment by one level at a time

Install

npm:

npm install remark-lint-heading-increment

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-heading-increment",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-heading-increment 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-heading-increment'))
   .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