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

header id conflicts #1135

Closed
1 task done
egoist opened this issue Nov 14, 2019 · 3 comments · Fixed by #2413
Closed
1 task done

header id conflicts #1135

egoist opened this issue Nov 14, 2019 · 3 comments · Fixed by #2413
Labels
bug Functionality does not match expectation

Comments

@egoist
Copy link

egoist commented Nov 14, 2019

Problem

Sometimes the IDs in README.md are conflicted with the IDs generated from types.

Suggested Solution

Maybe add prefix to the ID generated from types?

@Gerrit0 Gerrit0 added bug Functionality does not match expectation needs reproduction Needs a minimal reproducible case labels Nov 14, 2019
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 14, 2019

I may be missing something, but when does this actually happen? At least in the default theme, it looks like we don't render anything with anchors but the readme on the page that displays it.

https://typedoc.org/api/

@egoist
Copy link
Author

egoist commented Nov 15, 2019

@Gerrit0: it looks like we don't render anything with anchors but the readme on the page that displays it.

That's exactly what I mean (https://majo.egoist.sh):

image

These two things use the same ID, you may add a prefix to either one of them.

@Gerrit0 Gerrit0 added reproduced and removed needs reproduction Needs a minimal reproducible case labels Nov 18, 2019
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 18, 2019

Thanks, I didn't consider the minimal theme. PR welcome to add a prefix, I think it would be better to prefix the readme.

The whole anchor / url scheme needs reworking (two variables Foo and foo will have duplicate IDs), but that's a much larger task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants