feat: Add no-h1-content and no-empty-heading rules#7
Merged
Conversation
Only TOC-style content (blank lines, anchor links, badges, HTML comments) is allowed under the first H1; any other content is reported. Includes rule implementation, tests, fixture, and config/docs updates.
- Custom rule flags H2+ headings with no content before the next same-or-higher heading. - Supports excludePathPatterns (e.g. **/*_index.md) and per-section suppress via <!-- no-empty-heading allow --> on its own line; other HTML comments allowed in section. - Unit tests, positive/negative fixtures, and docs/config updated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds two new custom markdownlint rules for heading structure:
excludePathPatterns(e.g.**/*_index.md) and per-section suppress via<!-- no-empty-heading allow -->on its own line.Changes
no-h1-content.jsandno-empty-heading.jsinmarkdownlint-rules/, with shared logic for allowed/suppress patterns andexcludePathPatternsviautils.js..markdownlint-cli2.jsonc..markdownlint.ymldocumentsno-h1-content(commented) and enablesno-empty-headingwithexcludePathPatterns: ["**/*_index.md"].test/markdownlint-rules/for both rules; new/updated fixtures inmd_test_files/andexpected_errors.yml.markdownlint-rules/README.mdupdated with rule descriptions, config options, and TOC/checklist where relevant.