remark-lint-no-heading-like-paragraph
remark-lint
rule to warn when “headings” have too many hashes.
Contents
What is this?
This package checks for broken headings.
When should I use this?
You can use this package to ensure that no broken headings are user, which instead will result in paragraphs with the #
characters shown.
Presets
This plugin is not included in presets maintained here.
Install
This package is ESM only. In Node.js (version 16+), 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 remarkLint from 'remark-lint'
import remarkLintNoHeadingLikeParagraph from 'remark-lint-no-heading-like-paragraph'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoHeadingLikeParagraph)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-heading-like-paragraph .
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. It exports no additional TypeScript types. The default export is remarkLintNoHeadingLikeParagraph
.
unified().use(remarkLintNoHeadingLikeParagraph)
Warn when “headings” have too many hashes.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
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 maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-no-heading-like-paragraph@3
, compatible with Node.js 12.
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.