Open
Description
openedon Aug 8, 2022
Markdown allows links to appear in headings, but rustdoc doesn't (properly) support this. @GuillaumeGomez had a PR to implement this: #94360. However, supporting this feature makes other parts of rustdoc's UI worse: Currently, rustdoc makes headers link to themselves (to make grabbing a link to the header easier). If we supported user links in headers, this wouldn't work anymore. We could use “§”, but it presents a small click target and adds visual noise. So, more discussion is needed.
- Determine rustdoc's status quo for this feature
- Decide whether it makes sense to support this
- If yes, decide how header self-links should be implemented
- If no, decide if we should warn when users make links in headers, or if we should maintain the status quo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment