-
Notifications
You must be signed in to change notification settings - Fork 798
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Multiple h1s in Changelog - there should only be one #208
Comments
100% agree! I filed an issue here: conventional-changelog/conventional-changelog#214 The response I got indicated that this is by design, and that it's determined by this template file: I would very much like to standardize around a more semantic convention (h1 for title, h2 for version section, h3-6 for headings specific to a version). |
Thanks! I added a comment over there. |
@marcysutton @ungoldman for the record, I'm definitely in favor of us having valid markup! and would happily help land any tickets related to this. |
Probably we don't need |
PR opened here: conventional-changelog/conventional-changelog#237 |
Related issues: - #214 (comment) - conventional-changelog/standard-version#208 BREAKING CHANGE: Logic for generating release headings has been changed to make all heading levels the same (`##`/`h2`) for better compatibility with screen readers and parsers, and to conform to HTML semantics. Patch release titles are now wrapped in a `<small>` tag to maintain the visual hierarchy of the previous style. Fixes #214
So we need to bump the version of |
Any plans on upgrading to latest |
Same issue sed -e '2,${s/^# /## /}' -e 's/Change Log/Changelog/' -i CHANGELOG.md |
@NateScarlet is the fix simply upgrading the version of conventional-changelog? will do so soon, working on a release with a few exciting things. |
This should now be fixed as of |
Related issues: - conventional-changelog/conventional-changelog#214 (comment) - conventional-changelog/standard-version#208 BREAKING CHANGE: Logic for generating release headings has been changed to make all heading levels the same (`##`/`h2`) for better compatibility with screen readers and parsers, and to conform to HTML semantics. Patch release titles are now wrapped in a `<small>` tag to maintain the visual hierarchy of the previous style. Fixes conventional-changelog/conventional-changelog#214
Related issues: - conventional-changelog/conventional-changelog#214 (comment) - conventional-changelog/standard-version#208 BREAKING CHANGE: Logic for generating release headings has been changed to make all heading levels the same (`##`/`h2`) for better compatibility with screen readers and parsers, and to conform to HTML semantics. Patch release titles are now wrapped in a `<small>` tag to maintain the visual hierarchy of the previous style. Fixes conventional-changelog/conventional-changelog#214
Related issues: - conventional-changelog/conventional-changelog#214 (comment) - conventional-changelog/standard-version#208 BREAKING CHANGE: Logic for generating release headings has been changed to make all heading levels the same (`##`/`h2`) for better compatibility with screen readers and parsers, and to conform to HTML semantics. Patch release titles are now wrapped in a `<small>` tag to maintain the visual hierarchy of the previous style. Fixes conventional-changelog/conventional-changelog#214
The HTML output in the change logs produced by this tool include too many h1 elements. There should be one at the top for "Change Log", and the individual releases should be h2's so the content hierarchy makes sense and follows best practices for accessible headings.
Here's what it outputs now:
Here's what it should be:
I couldn't figure out where those come from after a quick look through the source, perhaps it's from one of the dependent modules? I'm happy to submit a PR if someone can point me in the right direction (including to another repo, if needed).
The text was updated successfully, but these errors were encountered: