chore(docs): upgrade docs site to @nebari/starlight v0.2.0#46
Merged
Conversation
Bumps the shared Nebari Starlight theme from 0.1.6 to 0.2.0. The theme's
plugin API is unchanged, but v0.2.0 peer-requires Astro >=7.0.6, so this
also moves the site off Astro 5:
- @nebari/starlight ^0.1.5 -> ^0.2.0
- astro ^5.0.0 -> ^7.0.6
- @astrojs/starlight ^0.33.0 -> ^0.41.3 (Astro 7 requires it)
Two breaking changes surfaced and are handled here:
- Starlight 0.39.0 dropped `label` + `autogenerate` on a single sidebar
entry; the CLI Reference group now wraps its autogenerate config in an
`items` array.
- Astro 7 ships a new native markdown pipeline. The custom
remark-base-links plugin still runs via `markdown.remarkPlugins`
because @astrojs/markdown-remark comes in as a peer of Astro and
Starlight. Verified in the built output: root-absolute content links
are still prefixed with the deployed base path.
CI Node ('22') and local Node both satisfy Astro 7's >=22.12.0.
|
📄 Docs preview for |
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.
Updates the docs site (
docs/site) to the Nebari Starlight v0.2.0 theme.What changed
@nebari/starlight^0.1.5^0.2.0astro^5.0.0^7.0.6astro >=7.0.6@astrojs/starlight^0.33.0^0.41.3astro ^7.0.2)The
@nebari/starlightplugin API is unchanged (nebari()is used the same way), but the theme's peer deps jump Astro two majors (5 to 7), which is what pulls in the rest of this diff.Breaking changes handled
label+autogenerateon a single sidebar entry. The CLI Reference group now wraps itsautogenerateconfig in anitemsarray.remark-base-linksplugin (which prefixes root-absolute links with the deployed/nebari-frames/base path) still runs throughmarkdown.remarkPluginsbecause@astrojs/markdown-remarkcomes in as a peer of both Astro and Starlight. No extra dependency was needed.Verification
Built locally with the same
SITE/BASEthemaindeploy uses:npm ciresolvesastro@7.0.6,@astrojs/starlight@0.41.3,@nebari/starlight@0.2.0, 0 vulnerabilities/nebari-frames/installation/); no unprefixed content links leakedSocialIconsoverride still renders only the repo-specific GitHub link (no org-level duplicate)CI Node (
'22') and local Node both satisfy Astro 7's>=22.12.0.Follow-up (not in this PR)
Astro 7 emits a deprecation warning for
markdown.remarkPlugins(it now prefers passing plugins tounified({...})from@astrojs/markdown-remark). It still works today; portingremark-base-linksoff the deprecated option is a future cleanup.