Warn when emphasis (including strong), instead of a heading, introduces
a paragraph.
Presets
This rule is included in the following presets:
Example
ok.md
In
# Foo
Bar.
Out
No messages.
not-ok.md
In
*Foo*
Bar.
__Qux__
Quux.
Out
1:1-1:6: Don’t use emphasis to introduce a section, use a heading
5:1-5:8: Don’t use emphasis to introduce a section, use a heading
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-lint-no-emphasis-as-heading
This package exports no identifiers.
The default export is remarkLintNoEmphasisAsHeading
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-emphasis-as-heading",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-emphasis-as-heading readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoEmphasisAsHeading from 'remark-lint-no-emphasis-as-heading'
remark()
.use(remarkLint)
+ .use(remarkLintNoEmphasisAsHeading)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(file))
})
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.
License
MIT © Titus Wormer