feat: add githubHref and logo theme options - #31
Merged
Conversation
Two new options on nebari(): - githubHref: points the header GitHub icon at a specific repository instead of the hard-coded nebari-dev org link, so each pack's docs can link to its own repo without copying a SocialIcons override. - logo: replaces the bundled Nebari mark in the header with the site's own light/dark images and alt text. Omitted variants cross-fall back so a single-image logo only needs one entry; no option keeps the bundled mark. Version bumped to 0.3.0 (EffVer meso: new backwards-compatible options). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Aug 26, 2026
Merged
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.
Summary
Adds two backwards-compatible options to
nebari()so consuming docs sites can customize the header without copying component overrides:githubHref— points the header GitHub icon at a specific repository instead of the hard-codedhttps://github.com/nebari-devorg link. This lets each pack link the icon to its own repo with one line of config (replacing theSocialIcons.astroworkaround nebari-frames currently carries).logo— replaces the bundled Nebari mark in the header with the site's own images:{ light, dark, alt }. Values are used as the<img src>verbatim (files inpublic/, or absolute URLs; root-absolute paths get the site base prefixed at build time by the existingwithBasePrefixpass). Omitted variants cross-fall back so a single-image logo only needslight;altdefaults to"Nebari"; omitting the option entirely keeps the bundled mark.Both options flow through the existing
virtual:nebari/configmodule;virtual.d.tsand the README are updated accordingly.Version bumped to 0.3.0 (EffVer meso — new features, no breaking changes), so this is release-ready on merge.
Motivation
The Nebari packs portal wants every pack's docs header to link the logo to https://packs.nebari.dev and the GitHub icon to the pack's own repository. Today
logoHrefcovers the first, but the GitHub icon is hard-coded to the org, forcing per-packSocialIconscomponent copies. These options make both one-line config changes in each pack.Testing
packages/starlight/test/options.test.tscovers: default org link,githubHrefoverride, consumersocialentries preserved,logodefaulting to null, variant cross-fallback, explicit variants + alt, andlogoHrefpass-through.bun test, including the docs build tests): 25 pass / 0 fail.bun run check(biome): clean.Close #30
🤖 Generated with Claude Code