unified

Project: remarkjs/remark-lint

Package: remark-lint-strong-marker@2.0.1

  1. Dependencies: 4·Dependents: 17
  2. remark-lint rule to warn when importance (strong) markers violate the given style
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. marker 12

remark-lint-strong-marker

Build Coverage Downloads Size Sponsors Backers Chat

Warn for violating importance (strong) markers.

Options: 'consistent', '*', or '_', default: 'consistent'.

'consistent' detects the first used importance style and warns when subsequent importance sequences use different styles.

Fix

remark-stringify formats importance using an * (asterisk) by default. Pass strong: '_' to use _ (underscore) 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:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide'*'

Example

ok.md
In
**foo** and **bar**.
Out

No messages.

also-ok.md
In
__foo__ and __bar__.
Out

No messages.

not-ok.md
In
**foo** and __bar__.
Out
1:13-1:20: Strong should use `*` as a marker
ok.md

When configured with '*'.

In
**foo**.
Out

No messages.

ok.md

When configured with '_'.

In
__foo__.
Out

No messages.

not-ok.md

When configured with '💩'.

Out
1:1: Incorrect strong marker `💩`: use either `'consistent'`, `'*'`, or `'_'`

Install

npm:

npm install remark-lint-strong-marker

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-strong-marker",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-strong-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-strong-marker'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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