remark-lint-no-heading-like-paragraph
remark-lint rule to warn when h7+ “headings” are used.
Contents
What is this?
This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.
When should I use this?
You can use this package to ensure that no heading-like constructs are created, which instead will result in paragraphs with the # characters shown.
Presets
This rule is not included in a preset maintained here.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-no-heading-like-paragraph
In Deno with esm.sh:
import remarkLintNoHeadingLikeParagraph from 'https://esm.sh/remark-lint-no-heading-like-paragraph@3'
In browsers with esm.sh:
<script type="module">
import remarkLintNoHeadingLikeParagraph from 'https://esm.sh/remark-lint-no-heading-like-paragraph@3?bundle'
</script>
Use
On the API:
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await remark()
.use(remarkLint)
.use(remarkLintNoHeadingLikeParagraph)
.process(file)
console.error(reporter(file))
On the CLI:
remark --use remark-lint --use remark-lint-no-heading-like-paragraph example.md
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-heading-like-paragraph",
…
]
}
…
API
This package exports no identifiers. The default export is remarkLintNoHeadingLikeParagraph.
unified().use(remarkLintNoHeadingLikeParagraph[, config])
This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).
There are no options.
Examples
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
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.