prepare to introduce intra-page navigation aids #168

New issue

Open

opened 2025-10-14 15:50:17 -06:00 by navan · 0 comments

navan commented

2025-10-14 15:50:17 -06:00

Owner

Originally created by @tayloraswift on 6/3/2024

per discussion here we should have a ‘table of contents’ sidebar feature similar to DocC, for jumping to the heading on the current page.

my gut feeling is this is something we want to implement on the client-side, via javascript. for that to work, we need to get a grip on the anchored headings we generate on the server-side for each page.

add sanitizer to SSGC, to prevent it from allowing articles to contain more than one heading with the same text
develop a mangling scheme for the extension blocks, so that we can link to the Conformances subsections inside of them. this is likely the hardest part, since no such identity exists within the Swift compiler, so we will have to invent one
emit heading anchors for those Conformances subsections

*Originally created by @tayloraswift on 6/3/2024* per [discussion here](https://github.com/tayloraswift/swift-unidoc/discussions/231) we should have a ‘table of contents’ sidebar feature similar to DocC, for jumping to the heading on the current page. my gut feeling is this is something we want to implement on the client-side, via javascript. for that to work, we need to get a grip on the anchored headings we generate on the server-side for each page. - [ ] add sanitizer to SSGC, to prevent it from allowing articles to contain more than one heading with the same text - [x] develop a mangling scheme for the extension blocks, so that we can link to the **Conformances** subsections inside of them. this is likely the hardest part, since no such identity exists within the Swift compiler, so we will have to invent one - [x] emit heading anchors for those **Conformances** subsections