@sfdocs-internal/remark-lint-heading-linting-rules v0.1.1

Remark lint Check Allowed Headers

What and Why

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check allowed markdown headings level. For example ; You can allow // All H1s (#) must be followed by text. You cannot have an H1 and then an H2 (##) without text in between. // If there is an H2 (##), there must be at least 2 H2s. // If there is an H3 (###), there must be at least 2 H3s. // There must be text between the H2 and the first H3. // If there is an H4 (####), there must be at least 2 H4s.

Configuration

Use

How to set up

Install & build

yarn install && yarn build

Publish

yarn publish

Make sure to push your changes (version number & other changes) to git when publishing is complete.