fix: remove heading level skips from the heading outline#1
Merged
Conversation
The heading outline of the generated docs skipped levels (h1 -> h3 -> h5), which violates axe's heading-order rule and makes screen-reader navigation harder, and the debug route rendered examples with no heading context at all, so no example markup heading level could be correct on both pages. - The "Examples" section heading is now an h2 instead of an h3, but is still sized like an h3 (the other section headings are unchanged, since they only follow h3 or lower headings). - Example titles are now h3 instead of h5, but are still sized like h5 via custom properties that the playground sets on the markdown component. - The debug route now renders the same heading context as the component page: the component name as a small h2 and the example title as a small h3. With this, example markup using h4 captions is correct on both the component page and the debug page. fix: jgroth#184
adrianschmidt
force-pushed
the
fix/heading-outline
branch
from
ba55589 to
b11ba6a
Compare
Kiarokh
approved these changes
Jun 12, 2026
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
2 participants
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.
Fork-side PR for jgroth#185 (fixes jgroth#184), following the FORK.md workflow: the branch is based on
main, the identical change is PR'd upstream, and merging here releases it as@limetech/kompendiumwithout waiting for upstream review.See the upstream PR for the full description. In short: the "Examples" section heading becomes an h2, example titles become h3, and the debug route gains matching context headings — all keeping today's visual design. This lets lime-elements use h4 captions in example markup and ratchet all 18
heading-orderentries out of its axe baseline.This is the fork's first code change, so merging this PR doubles as the trial run of the automatic release pipeline.
🤖 Generated with Claude Code