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

fix(html): correctly handle examples in document navigation #612

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

crowlKats
Copy link
Member

Fixes denoland/docs#573.

Fixes 3 things:

  • if first element is not the top-most element in a document navigation, it would break since it would only look at the first element's depth, instead of taking the highest ranking element's depth.
  • removes the top-level rendering of "Examples" in the document navigation for functions, since functions have examples in each overload instead of at the generic symbol level.
  • adds support for individual example titles being rendered in the document navigation, unlike before where it would only render "Examples" without any sub-elements.

Copy link
Member

@bartlomieju bartlomieju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@crowlKats crowlKats merged commit 8e6dfc2 into main Jul 12, 2024
5 checks passed
@kt3k kt3k deleted the html-fix-examples-toc branch July 13, 2024 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

overloads break document document navigation
2 participants