Resolve sidebar logo for all sidebars, not just the first#14355
Open
Resolve sidebar logo for all sidebars, not just the first#14355
Conversation
The logo resolution logic (resolveLogo + logoAddLeadingSlashes) only ran
for sidebars[0]. Other sidebars kept raw string logo values, but the EJS
template expects { light: { path }, dark: { path } } objects since the
dark logo support was added in #12996. This caused empty <a> anchors
with no <img> for any sidebar after the first.
Loop the resolution over all sidebar entries so each sidebar's logo is
properly transformed.
Preserve inheritance: sidebars that don't define logo should inherit from the first sidebar via propagation spread. Add changelog entry and test coverage for the inheritance case.
Only skip logo normalization for secondary sidebars (i > 0) so the first sidebar still resolves brand logos via resolveLogo when no explicit logo is set. Add brand-multi-sidebar test fixture verifying brand logos render on both sidebars without explicit logo config.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The logo resolution logic (
resolveLogo+logoAddLeadingSlashes) only ran forsidebars[0]. Other sidebars kept raw string logo values, but the EJS template expects{ light: { path }, dark: { path } }objects since the dark logo support was added in #12996 (v1.8.15). This caused empty<a class="sidebar-logo-link">anchors with no<img>for any sidebar after the first.Fix
Loop the resolution over all sidebar entries that explicitly define a
logoso each sidebar's logo is properly transformed. Sidebars without alogokey still inherit the first sidebar's logo via the existing propagation spread. Sidebars withlogo: falsestill opt out of displaying a logo.Closes #14353, closes #13565