-
Notifications
You must be signed in to change notification settings - Fork 8
Document redesigned dynamic OG images with toggle flags and color overrides #4322
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
7548309
Add og:text-color and og:background-color documentation and changelog…
devin-ai-integration[bot] 9fee39d
Rename og:text-color/og:background-color to og:dynamic:text-color/og:…
devin-ai-integration[bot] 2549233
Fix vale warning: remove time-relative term 'now'
devin-ai-integration[bot] 046d3e8
Add toggle flags documentation and update changelog for OG image rede…
devin-ai-integration[bot] 90b1776
Merge branch 'main' into devin/1773760543-og-text-color-docs
devin-ai-integration[bot] 37008af
Document og:dynamic:logo-color and add conflicts/precedence note
devin-ai-integration[bot] 88fe33c
clarify text + structure
devalog 4a64631
Add defaults to SEO metadata ParamFields
devin-ai-integration[bot] a8537a2
Merge branch 'main' into devin/1773760543-og-text-color-docs
devin-ai-integration[bot] bf9d931
Add specific default color values to og:dynamic color ParamFields
devin-ai-integration[bot] 5e3d7f9
restructure
devalog d25ee72
Merge branch 'devin/1773760543-og-text-color-docs' of https://github.…
devalog 93b461a
Add all new properties to changelog YAML example
devin-ai-integration[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| tags: ["seo", "configuration", "docs.yml"] | ||
| --- | ||
|
|
||
| ## Dynamic OG image color overrides <Availability type="beta" /> [#og-color-overrides] | ||
|
|
||
| You can now control the text and background colors of dynamically generated OG images. Set `og:text-color` and `og:background-color` in your `docs.yml` metadata to override the auto-detected theme colors. This is useful when your site has a light background where the default white text is hard to read. | ||
|
|
||
| ```yaml docs.yml | ||
| metadata: | ||
| og:dynamic: true | ||
| og:text-color: "#1a1a1a" | ||
| og:background-color: "#ffffff" | ||
| ``` | ||
|
|
||
| <Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/seo/setting-seo-metadata#dynamic-og-images">Read the docs</Button> | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated