remark-lint-rule-style

remark-lint-rule-style

Warn when the horizontal rules violate a given or detected style.

Note that horizontal rules are also called “thematic break”.

Options: string, either a valid markdown rule, or consistent, default: 'consistent'.

Install

npm install --save remark-lint-rule-style

Example

When this rule is '* * *', the following file valid.md is ok:

<!-- This is also valid when `consistent`. -->

* * *

* * *

When this rule is '_______', the following file valid.md is ok:

<!-- This is also valid when `consistent`. -->

_______

_______

When this rule is turned on, the following file invalid.md is not ok:

<!-- Always invalid. -->

***

* * *

5:1-5:6: Rules should use `***`

When '!!!' is passed in, the following error is given:

1:1: Invalid preferred rule-style: provide a valid markdown rule, or `'consistent'`

License

MIT © Titus Wormer