feat(v2): docs version banner configuration option#5052
Merged
Conversation
… instead of using "useActiveVersion" + global data
|
✔️ [V2] 🔨 Explore the source changes: 0feff47 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60d4a9f4ade8510008f1aba6 😎 Browse the preview: https://deploy-preview-5052--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5052--docusaurus-2.netlify.app/ |
|
Size Change: -40 B (0%) Total Size: 571 kB
ℹ️ View Unchanged
|
This was referenced Jun 29, 2021
mostlyobvious
added a commit
to RailsEventStore/rails_event_store
that referenced
this pull request
Jul 11, 2025
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
2 participants
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.
Breaking changes:
@theme/DocVersionSuggestionscomponent API modified, and component is renamed toDocVersionBanner.@theme/DocVersionSuggestionsand@theme/DocItemshould probably be reswizzled/updatedMotivation
Fixes #3013
By default, we display a banner at the top of docs versions that are not the latest version, saying the version is either unreleased or unmaintained.
This is a problem for some sites that want to disable this banner.
Currently, the only solution is swizzle the banner component, which is a bit annoying for users.
This PR adds a new version config option so that the banner can be customized/disabled per-version.
This may not be the best API in case you want to disable the site on ALL banners at once, but is a good low-level first step enabling the user to disable banners without swizzling. We can introduce more APIs for that later.
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
tests