remark-lint
rule to warn when HTML is used.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Examples
- Compatibility
- Contribute
- License
This package checks HTML.
You can use this package to check that no HTML is used.
This plugin is not included in presets maintained here.
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@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoHtml from 'https://esm.sh/remark-lint-no-html@4?bundle'
</script>
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",
…
]
}
…
This package exports no identifiers.
It exports the TypeScript type
Options
.
The default export is
remarkLintNoHtml
.
Warn when HTML is used.
-
options
(Options
, optional) — configuration
Transform (Transformer
from unified
).
Configuration (TypeScript type).
-
allowComments
(boolean
, default:true
) — allow comments or not
# Mercury
<!--Venus-->
No messages.
<h1>Mercury</h1>
1:1-1:17: Unexpected HTML, use markdown instead
When configured with { allowComments: false }
.
<!--Mercury-->
1:1-1:15: Unexpected HTML, use markdown instead
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@4
,
compatible with Node.js 16.
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.