remark-lint-no-html
remark-lint rule to warn when HTML is used.
Contents
What is this?
This package checks HTML.
When should I use this?
You can use this package to check that no HTML is used.
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-html
In Deno with esm.sh:
import remarkLintNoHtml from 'https://esm.sh/remark-lint-no-html@3'
In browsers with esm.sh:
<script type="module">
import remarkLintNoHtml from 'https://esm.sh/remark-lint-no-html@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoHtml from 'remark-lint-no-html'
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(remarkLintNoHtml)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-html .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-html",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoHtml.
unified().use(remarkLintNoHtml)
Warn when HTML is used.
Parameters
There are no options.
Returns
Transform (Transformer from unified).
Examples
ok.md
In
# Hello
<!--Comments are also OK-->
Out
No messages.
not-ok.md
In
<h1>Hello</h1>
Out
1:1-1:15: Do not use HTML in markdown
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-html@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.