lint-md
@allons-y/opx-lint-md lints Markdown with ESLint and @eslint/markdown, pre-configured.
Install
yarn add --dev @allons-y/opx-lint-md
yarn opx enable md
Covers
| Files | Language mode |
|---|---|
.md |
markdown/commonmark |
.mdx |
markdown/gfm |
GitHub pull request and issue templates (.github/PULL_REQUEST_TEMPLATE*, .github/ISSUE_TEMPLATE/**) are ignored, because their task lists and placeholders trip Markdown rules. So are CHANGELOG.md files, which changesets generates with bracketed commit hashes.
Configure
Replace the bundled config with your own flat config:
{
"version": 1,
"lint": { "md": "./eslint.markdown.config.js" }
}
Export
The flat config is exported at @allons-y/opx-lint-md/eslint.config.js. See Compose your ESLint config.