Releases Changelog sections to have unique anchor tags
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6.9k
- Forks
- 1.1k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 57
Description
Package
v4.x
Description
On the releases page every header of given type (Features, Bug fixes, Contributors) has the same anchor attached to it which makes it impossible to link to specific contribution or breaking change info from that page. From what I understand that anchor generation happens automatically in MDC which will soon be replaced by Comark. I thought I first share my experience before diving deep into those libraries.
Additional context
I was upgrading to Nuxt UI the other day and I found my app not building. It was caused by breaking change in 4.6.0 - using moduleDependencies for @nuxt/icon and @nuxt/fonts. I wanted to pass that info to a colleague using anchor link on a release notes page and then I found out that each section has the same #breaking-changes link.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the releases page and inspect how MDC currently renders repeated changelog headings and generates their anchors, including the planned Comark replacement. Reproduce the issue with repeated sections such as Features, Bug fixes, or Contributors, then verify that each heading has a distinct link target, including the breaking-changes case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, nuxt, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100