mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
.. | ||
index.js | ||
package.json | ||
readme.md |
remark-lint-no-html
Warn when HTML nodes are used.
Ignores comments, because they are used by remark
, remark-lint
, other
markdown tools, and because markdown doesn’t have native comments.
Presets
This rule is not included in any default preset
Example
valid.md
In
# Hello
<!--Comments are also OK-->
Out
No messages.
invalid.md
In
<h1>Hello</h1>
Out
1:1-1:15: Do not use HTML in markdown
Install
npm install remark-lint-no-html
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-no-html",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-no-html readme.md
Or use this on the API:
var remark = require('remark');
var report = require('vfile-reporter');
remark()
.use(require('remark-lint'))
+ .use(require('remark-lint-no-html'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});