4.6 KiB
remark-lint-fenced-code-marker
Warn for violating fenced code markers.
Options: '`', '~', or 'consistent', default: 'consistent'.
'consistent' detects the first used fenced code marker style and warns
when subsequent fenced code blocks use different styles.
Fix
remark-stringify
formats fences using '`' (grave accent) by default.
Pass
fence: '~'
to use ~ (tilde) 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
ok.md
In
Indented code blocks are not affected by this rule:
bravo();
Out
No messages.
not-ok-consistent-tick.md
In
```alpha
bravo();
```
~~~
charlie();
~~~
Out
5:1-7:4: Fenced code should use `` ` `` as a marker
not-ok-consistent-tilde.md
In
~~~alpha
bravo();
~~~
```
charlie();
```
Out
5:1-7:4: Fenced code should use `~` as a marker
ok.md
When configured with '`'.
In
```alpha
bravo();
```
```
charlie();
```
Out
No messages.
ok.md
When configured with '~'.
In
~~~alpha
bravo();
~~~
~~~
charlie();
~~~
Out
No messages.
not-ok-incorrect.md
When configured with '💩'.
Out
1:1: Incorrect fenced code marker `💩`: use either `'consistent'`, `` '`' ``, or `'~'`
Install
npm:
npm install remark-lint-fenced-code-marker
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-fenced-code-marker",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-fenced-code-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-fenced-code-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.