Skip to content
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

Broken link for header with inline badge #16199

Open
toksdotdev opened this issue Aug 15, 2024 · 0 comments
Open

Broken link for header with inline badge #16199

toksdotdev opened this issue Aug 15, 2024 · 0 comments
Assignees
Labels
engineering Problems or updates to developers.cloudflare.com website

Comments

@toksdotdev
Copy link
Member

toksdotdev commented Aug 15, 2024

Example URL(s)

Actual Behavior

The space between the header text and the badge is converted to - when the url slug is generated.

Expected Behavior

Links referencing header sections with inline badges should be correct. Possible options: link anchors pointing to header ID with inline badges can be suffixed with -, or the - isn't included when the header ID is generated.

Additional information

I didn't want to put up a fix yet since a spacing is recommended in the style guide. However, in a case where the inline badge gets removed, it's likely the space gets trimmed off, which should easily break any existing anchor link referencing it. A few options right off my head:

  • Keep the spacing and suffixing links with -,
  • Use a   to represent the spacing.
  • Or something else?
@toksdotdev toksdotdev added the engineering Problems or updates to developers.cloudflare.com website label Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
engineering Problems or updates to developers.cloudflare.com website
Projects
None yet
Development

No branches or pull requests

3 participants