unified

Project: remarkjs/remark-lint

Package: remark-lint-no-multiple-toplevel-headings@3.1.0

  1. Dependents: 21
  2. remark-lint rule to warn when multiple top level headings are used
  1. remark 187
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. heading 27

remark-lint-no-multiple-toplevel-headings

Build Coverage Downloads Size Sponsors Backers Chat

Warn when multiple top level headings are used.

Options: number, default: 1.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide

Example

ok.md

When configured with 1.

In
# Foo

## Bar
Out

No messages.

not-ok.md

When configured with 1.

In
# Foo

# Bar
Out
3:1-3:6: Don’t use multiple top level headings (1: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-multiple-toplevel-headings

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

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-multiple-toplevel-headings",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-multiple-toplevel-headings readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoMultipleToplevelHeadings from 'remark-lint-no-multiple-toplevel-headings'

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