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

Double Paragraph marker in headers #40

Open
swheaton opened this issue Feb 28, 2025 · 2 comments
Open

Double Paragraph marker in headers #40

swheaton opened this issue Feb 28, 2025 · 2 comments
Labels
question Further information is requested
Milestone

Comments

@swheaton
Copy link
Contributor

It seems like headers have a double paragraph marker. They show up all the time on every header. Then if I hover it makes a second clickable paragraph marker. I would expect there's no paragraph marker all the time and the behavior of the second one should actually the first and only one.

Mac, Chrome browser

Image
@thesteve0 thesteve0 added the question Further information is requested label Feb 28, 2025
@thesteve0
Copy link
Collaborator

Yeah it is in all browsers. Known issue. I don't think of this as a blocker for launch but it can't stay this way.
We have anchors in the original pages AND mkdocs take markdown headers and automagically turns them into anchors.

I am tempted to remove all of our inline anchor references and just let mkdocs create anchors automagically. This feels friendlier to authors and more sustainable as a practice.
Thoughts?

@swheaton
Copy link
Contributor Author

swheaton commented Mar 1, 2025

Seems reasonable weighed against seeing the paragraph thingy all over the place.
As a frequent docs contributor, I sometimes like using explicit anchors because then I don't have to guess what the header is gonna turn into. especially if 2 headers have the same text. And Sphinx would automatically create anchors unless you specified an explicit one.
So I guess if mkdocs could do that, it would be ideal. But relying solely on automagic anchors is fine too.

@thesteve0 thesteve0 added this to the launch of MVP milestone Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants