{"library":"remark-lint-heading-style","title":"remark-lint-heading-style","description":"A remark-lint rule that warns when Markdown headings violate a specified or consistent style (ATX, ATX-closed, or setext). Version 4.0.1 is the latest stable release, part of the remark-lint ecosystem. It is ESM-only (Node 16+). Unlike alternatives like markdownlint, it integrates seamlessly with unified and remark, allowing programmatic linting and fixes. It supports automatic style detection (consistent) and explicit configuration. The package ships TypeScript types and is commonly used in presets like remark-preset-lint-consistent and remark-preset-lint-markdown-style-guide.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-heading-style"],"cli":null},"imports":["import remarkLintHeadingStyle from 'remark-lint-heading-style'","import type { Options } from 'remark-lint-heading-style'","import type { Style } from 'remark-lint-heading-style'"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import { unified } from 'unified'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport remarkLint from 'remark-lint'\nimport remarkLintHeadingStyle from 'remark-lint-heading-style'\nimport { read } from 'to-vfile'\nimport { reporter } from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintHeadingStyle, 'atx') // or 'consistent' (default)\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))","lang":"typescript","description":"Demonstrates unified pipeline to parse, lint headings for ATX style, and output warnings using vfile-reporter.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}