{"library":"remark-lint-first-heading-level","title":"remark-lint-first-heading-level","description":"remark-lint rule to enforce that the first heading in a Markdown document has a specific rank (1-6). Part of the remark-lint ecosystem. Current stable version 4.0.1, released as part of remark-lint monorepo with coordinated version bumps. Ships TypeScript types. ESM-only since v3. Works with unified, remark-parse, and remark-stringify.","language":"javascript","status":"active","last_verified":"Fri May 01","install":{"commands":["npm install remark-lint-first-heading-level"],"cli":{"name":"remark","version":null}},"imports":["import remarkLintFirstHeadingLevel from 'remark-lint-first-heading-level'","import type { Options } from 'remark-lint-first-heading-level'","import remarkLintFirstHeadingLevel from 'remark-lint-first-heading-level'"],"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 remarkLintFirstHeadingLevel from 'remark-lint-first-heading-level'\nimport { reporter } from 'vfile-reporter'\nimport { read } from 'to-vfile'\n\nconst file = await unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintFirstHeadingLevel, 1) // expect first heading level 1\n  .use(remarkStringify)\n  .process(await read('example.md'))\n\nconsole.error(reporter(file))","lang":"typescript","description":"Checks that the first heading in example.md is rank 1, warns otherwise.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}