mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00

History

David Anson 480958352e Some checks are pending Checkers / linkcheck (push) Waiting to run Details Checkers / spellcheck (push) Waiting to run Details CI / build (20, macos-latest) (push) Waiting to run Details CI / build (20, ubuntu-latest) (push) Waiting to run Details CI / build (20, windows-latest) (push) Waiting to run Details CI / build (22, macos-latest) (push) Waiting to run Details CI / build (22, ubuntu-latest) (push) Waiting to run Details CI / build (22, windows-latest) (push) Waiting to run Details CI / build (24, macos-latest) (push) Waiting to run Details CI / build (24, ubuntu-latest) (push) Waiting to run Details CI / build (24, windows-latest) (push) Waiting to run Details CI / pnpm (push) Waiting to run Details CodeQL / Analyze (push) Waiting to run Details TestRepos / build (latest, ubuntu-latest) (push) Waiting to run Details UpdateTestRepos / update (push) Waiting to run Details Update string format output by formatLintResults to match markdownlint-cli2 (and markdownlint-cli).		2025-09-09 21:07:24 -07:00
..
.npmignore	Convert markdownlint library to an ECMAScript module, replace markdownlint-micromark with micromark, stop publishing (large) markdownlint-browser.js, see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for guidance.	2024-11-29 18:29:21 -08:00
helpers.cjs	Update string format output by formatLintResults to match markdownlint-cli2 (and markdownlint-cli).	2025-09-09 21:07:24 -07:00
LICENSE	Remove years from copyright statements.	2023-01-14 15:11:48 -08:00
micromark-helpers.cjs	Update MD007/ul-indent to account for 4-space base indent within footnote definitions (fixes #1679 ).	2025-08-03 15:38:25 -07:00
package.json	Update to version 0.38.0.	2025-05-02 20:22:08 -07:00
README.md	Update to version 0.38.0.	2025-05-02 20:22:08 -07:00
shared.cjs	Convert markdownlint library to an ECMAScript module, replace markdownlint-micromark with micromark, stop publishing (large) markdownlint-browser.js, see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for guidance.	2024-11-29 18:29:21 -08:00
test.cjs	Convert markdownlint library to an ECMAScript module, replace markdownlint-micromark with micromark, stop publishing (large) markdownlint-browser.js, see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for guidance.	2024-11-29 18:29:21 -08:00

README.md

markdownlint-rule-helpers

A collection of markdownlint helper functions for custom rules

Overview

The Markdown linter markdownlint offers a variety of built-in validation rules and supports the creation of custom rules. The internal rules share various helper functions; this package exposes those for reuse by custom rules.

API

Undocumented - This package exports the internal functions as-is. The APIs 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 annotations. That said, some of what's here will be useful to custom rule authors and may avoid duplicating code.

Tests

None - The entire body of code is tested to 100% coverage by the core markdownlint project, so there are no additional tests here.