Package Exports

remark-lint-strikethrough-marker

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-strikethrough-marker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-strikethrough-marker

Warn for violating strikethrough markers.

Options: 'consistent', '~', or '~~', default: 'consistent'.

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

Fix

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is not included in any default preset

Example

`ok.md`

When configured with '~'.

In

Note: this example uses GFM.

~foo~

Out

No messages.

`not-ok.md`

When configured with '~'.

In

Note: this example uses GFM.

~~foo~~

Out

1:1-1:8: Strikethrough should use `~` as a marker

`ok.md`

When configured with '~~'.

In

Note: this example uses GFM.

~~foo~~

Out

No messages.

`not-ok.md`

When configured with '~~'.

In

Note: this example uses GFM.

~foo~

Out

1:1-1:6: Strikethrough should use `~~` as a marker

`not-ok.md`

In

Note: this example uses GFM.

~~foo~~
~bar~

Out

2:1-2:6: Strikethrough should use `~~` as a marker

`not-ok.md`

When configured with '💩'.

Out

1:1: Incorrect strikethrough marker `💩`: use either `'consistent'`, `'~'`, or `'~~'`

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-strikethrough-marker

This package exports no identifiers. The default export is remarkLintStrikethroughMarker.

Use

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

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

Or use it on the CLI directly

remark -u lint -u lint-strikethrough-marker readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintStrikethroughMarker from 'remark-lint-strikethrough-marker'

 remark()
   .use(remarkLint)
+  .use(remarkLintStrikethroughMarker)
   .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.