mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
2.7 KiB
2.7 KiB
remark-lint-emphasis-marker
Warn for violating emphasis markers.
Options: 'consistent', '*', or '_', default: 'consistent'.
'consistent' detects the first used emphasis style and warns when
subsequent emphasis use different styles.
Fix
remark-stringify
formats emphasis using an underscore (_) by default. Pass
emphasis: '*'
to use asterisks instead.
See Using remark to fix your markdown on how to automatically fix warnings for this rule.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-consistent |
'consistent' |
remark-preset-lint-markdown-style-guide |
'*' |
Example
valid.md
When configured with '*'.
In
*foo*
Out
No messages.
invalid.md
When configured with '*'.
In
_foo_
Out
1:1-1:6: Emphasis should use `*` as a marker
valid.md
When configured with '_'.
In
_foo_
Out
No messages.
invalid.md
When configured with '_'.
In
*foo*
Out
1:1-1:6: Emphasis should use `_` as a marker
invalid.md
In
*foo*
_bar_
Out
2:1-2:6: Emphasis should use `*` as a marker
invalid.md
When configured with 'invalid'.
Out
1:1: Invalid emphasis marker `invalid`: use either `'consistent'`, `'*'`, or `'_'`
Install
npm install remark-lint-emphasis-marker
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-emphasis-marker",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-emphasis-marker 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-emphasis-marker'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});