unified

Project: remarkjs/remark-lint

Package: remark-lint-no-emphasis-as-heading@2.0.1

  1. Dependencies: 3·Dependents: 13
  2. remark-lint rule to warn when emphasis or importance is used instead of a heading
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. heading 26
  6. emphasis 2

remark-lint-no-emphasis-as-heading

Build Coverage Downloads Size Sponsors Backers Chat

Warn when emphasis (including strong), instead of a heading, introduces a paragraph.

Presets

This rule is included in the following presets:

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

Example

ok.md
In
# Foo

Bar.
Out

No messages.

not-ok.md
In
*Foo*

Bar.

__Qux__

Quux.
Out
1:1-1:6: Don’t use emphasis to introduce a section, use a heading
5:1-5:8: Don’t use emphasis to introduce a section, use a heading

Install

npm:

npm install remark-lint-no-emphasis-as-heading

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-emphasis-as-heading",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-emphasis-as-heading 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-emphasis-as-heading'))
   .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