feat: new docs options: versions.{badge,className} #5454
Merged
Conversation
This file contains 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
|
✔️ [V2] 🔨 Explore the source changes: 9024e62 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/612e07e25534220007241700 😎 Browse the preview: https://deploy-preview-5454--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5454--docusaurus-2.netlify.app/ |
Josh-Cena
reviewed
Aug 31, 2021
| @@ -69,6 +71,8 @@ export type VersionOptions = { | |||
| path?: string; | |||
| label?: string; | |||
| banner?: VersionBanner; | |||
| badge?: boolean; | |||
There was a problem hiding this comment.
Suggested change
| badge?: boolean; | |
| showBadge?: boolean; |
badge is a noun but showBadge sounds more boolean
There was a problem hiding this comment.
agree, but I plan later to make it a string | boolean so for better extensibility without breaking change I prefer to keep badge here
|
Size Change: +156 B (0%) Total Size: 822 kB
ℹ️ View Unchanged
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
More customization options for docs versions:
badgeallows to show/hide the version badge on a per-version basisclassNameallows to customize the rendering on a per-version basis. Class is applied to<html>so that users can even target layout elements (a good use-case is to hide some navbar elements on a per-version basis using CSS, potential workaround for Dynamic navbar: navbar item activation strategies #4389)Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
tests