Repository navigation
Add Open Graph image and Twitter card to docs pages - #12456
Closed
astra-intelligence wants to merge 1 commit into
Closed
astra-intelligence wants to merge 1 commit into
astra-intelligence wants to merge 1 commit into
Conversation
sphinxext-opengraph emits og:title/description, but no og:image and no twitter:card, so every shared docs.godotengine.org link renders without a preview image. Add a 1200x630 brand card (_static/og-image.png, generated by tools/make-og-image.py) and wire it up via ogp_image + a summary_large_image Twitter card through ogp_custom_meta_tags.
Member
|
Thank you for your contribution but we do not accept AI authored contributions to the documentation, see [this]https://contributing.godotengine.org/en/latest/development/contribution_rules.html#for-contributors) Thank you for your contribution nonetheless |
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
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.
Add Open Graph image + Twitter card to every docs page
When a docs.godotengine.org link is shared on X/Twitter, Slack, Discord, LinkedIn or any social platform, the preview currently renders without an image — the site has
og:title/og:description(fromsphinxext-opengraph) but noog:imageand notwitter:card. Each share shows a bare text link instead of a branded card.What's included
_static/og-image.png— a 1200×630 social preview image matching the Godot brand: dark navy ground, blue accent bar, section pills (Getting started / Step-by-step / Tutorials / Class reference / Community) anddocs.godotengine.orgchip. Generated bytools/make-og-image.py(Pillow-only, reproducible).conf.py— setsogp_image/ogp_image_altso the extension emitsog:imageon every page, plusogp_custom_meta_tagsfor an explicitsummary_large_imageTwitter card. No explicittwitter:imageis set, so Twitter falls back to the version-awareog:image(works forstable,latest, and every4.xbranch).Verification
Built locally with Sphinx 8.1.3 +
sphinxext-opengraph0.13.0 (pinned versions). Confirmed on the built site:Per-page
og:title/og:descriptioncontinue to be emitted as before.