npm.io
1.0.0 • Published 3d ago

markdownlint-config-nick2bad4u

Licence
MIT
Version
1.0.0
Deps
2
Size
27 kB
Vulns
0
Weekly
0

markdownlint-config-nick2bad4u

Continuous Integration

Shareable styles for David Anson's Node markdownlint.

Install

npm install --save-dev markdownlint-cli markdownlint-config-nick2bad4u

Presets

Preset Intended use
recommended Practical source Markdown with selected semantic HTML.
strict 100-column prose and no inline HTML.
docs Docusaurus/GFM documentation with a reviewed HTML allowlist.
generated Changelogs and generated API output with narrow relaxations.

Native extends

Create .markdownlint.json in the consumer:

{
 "extends": "markdownlint-config-nick2bad4u/presets/docs.json",
 "MD013": false
}

Then run the Node CLI normally:

{
 "scripts": {
  "lint:markdown": "markdownlint \"**/*.md\""
 }
}

The raw compatibility path node_modules/markdownlint-config-nick2bad4u/recommended.json is also available for markdownlint --config.

JavaScript API

import {
 createMarkdownlintConfig,
 getMarkdownlintConfigPath,
 loadMarkdownlintConfig,
} from "markdownlint-config-nick2bad4u";

const strict = await loadMarkdownlintConfig("strict");
const docsPath = getMarkdownlintConfigPath("docs");
const customized = createMarkdownlintConfig("recommended", { MD013: false });

Important ecosystem distinction

This package targets the Node package named markdownlint and the markdownlint-cli/markdownlint-cli2 CLIs. It is not a style for the unrelated Ruby mdl implementation published from markdownlint/markdownlint. Do not pass these JSON files to Ruby mdl --style.

Requirements

  • Node.js ^22.22.3, ^24.16.0, or >=26.3.0
  • markdownlint ^0.41.1

License

MIT

Keywords