2019-04-13 11:18:57 -07:00
|
|
|
# markdownlint-rule-helpers
|
|
|
|
|
|
|
|
|
|
> A collection of `markdownlint` helper functions for custom rules
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2022-11-05 17:34:37 -07:00
|
|
|
The [Markdown][markdown] linter [`markdownlint`][markdownlint] offers a variety
|
|
|
|
|
of built-in validation [rules][rules] and supports the creation of [custom
|
|
|
|
|
rules][custom-rules]. The internal rules share various helper functions; this
|
|
|
|
|
package exposes those for reuse by custom rules.
|
2019-04-13 11:18:57 -07:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2022-11-13 20:53:10 -08:00
|
|
|
*Undocumented* - This package exports the internal functions as-is. The APIs
|
2022-11-05 17:34:37 -07:00
|
|
|
were not originally meant to be public, are not officially supported, and may
|
|
|
|
|
change from release to release. There are brief descriptive comments above each
|
|
|
|
|
function, but no [JSDoc][jsdoc] annotations. That said, some of what's here will
|
|
|
|
|
be useful to custom rule authors and may avoid duplicating code.
|
2019-04-13 11:18:57 -07:00
|
|
|
|
|
|
|
|
## Tests
|
|
|
|
|
|
2022-11-13 20:53:10 -08:00
|
|
|
*None* - The entire body of code is tested to 100% coverage by the core
|
2022-11-05 17:34:37 -07:00
|
|
|
`markdownlint` project, so there are no additional tests here.
|
|
|
|
|
|
2024-12-14 20:15:46 -08:00
|
|
|
[custom-rules]: https://github.com/DavidAnson/markdownlint/blob/v0.37.1/doc/CustomRules.md
|
2022-11-05 17:34:37 -07:00
|
|
|
[jsdoc]: https://en.m.wikipedia.org/wiki/JSDoc
|
|
|
|
|
[markdown]: https://en.wikipedia.org/wiki/Markdown
|
|
|
|
|
[markdownlint]: https://github.com/DavidAnson/markdownlint
|
2024-12-14 20:15:46 -08:00
|
|
|
[rules]: https://github.com/DavidAnson/markdownlint/blob/v0.37.1/doc/Rules.md
|
