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

prepare to introduce intra-page navigation aids #254

Open
2 of 3 tasks
tayloraswift opened this issue Jun 3, 2024 · 2 comments
Open
2 of 3 tasks

prepare to introduce intra-page navigation aids #254

tayloraswift opened this issue Jun 3, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@tayloraswift
Copy link
Owner

tayloraswift commented Jun 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
@tayloraswift tayloraswift added the enhancement New feature or request label Jun 3, 2024
@tayloraswift
Copy link
Owner Author

once #269 is complete, we should have an intrapage sidebar that supports jumping to named headings, although no generated extension blocks yet (due to lack of supported mangling scheme)

@tayloraswift
Copy link
Owner Author

#274 adds the extensions to the navigator as well

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

No branches or pull requests

1 participant