unified

Project: remarkjs/remark-lint

Package: remark-lint-no-heading-like-paragraph@3.0.1

  1. Dependents: 12
  2. remark-lint rule to for too many hashes (h7+ “headings”)
  1. remark 190
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. heading 26
  6. paragraph 4

remark-lint-no-heading-like-paragraph

Build Coverage Downloads Size Sponsors Backers Chat

Warn for h7+ “headings”.

Presets

This rule is not included in any default preset

Example

ok.md
In
###### Alpha

Bravo.
Out

No messages.

not-ok.md
In
####### Charlie

Delta.
Out
1:1-1:16: This looks like a heading but has too many hashes

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-heading-like-paragraph

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

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-heading-like-paragraph",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-heading-like-paragraph readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'

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