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

Links in headings render incorrectly in OTP #311

Open
1 of 3 tasks
shainaraskas opened this issue Jan 22, 2025 · 3 comments · May be fixed by #290
Open
1 of 3 tasks

Links in headings render incorrectly in OTP #311

shainaraskas opened this issue Jan 22, 2025 · 3 comments · May be fixed by #290
Assignees
Labels

Comments

@shainaraskas
Copy link

Describe the bug

Some headings were migrated with links (probably a bad practice)

These headings get weird rendering in the OTP nav (and very long anchors)

Image

https://bookish-dollop-9p66716.pages.github.io/docker.html#_windows_and_macos_with_docker_desktophttpswww_docker_comproductsdocker_desktop

Expected behavior

Either enforce stripping of links from headings (maybe with linting)

or

Strip links in OTP

This problem might go away if we lessen the number of levels we show in the OTP

Steps to reproduce

No response

Tooling

  • docs-builder
  • migration tooling
  • I'm not sure
@bmorelli25
Copy link
Member

Either enforce stripping of links from headings (maybe with linting)

I'm in favor of this option. I don't think linking from a heading should be allowed.

@bmorelli25
Copy link
Member

This also appears to be an edge case with minimal impact. We likely won't prioritize this in the migration tool.

@reakaleek
Copy link
Member

reakaleek commented Jan 23, 2025

This will also be fixed by #290 because any markdown will be stripped from the title in the navigation.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants