Add OpenGraph metadata for better link-preview thumbnails - #213
Merged
Conversation
Mintlify already auto-generates per-page og:title/og:description/ og:image/twitter:* from each page's own frontmatter title/description - confirmed live on the preview deployment. The actual gap was the plain default background with no illustration, so this adds a custom seo.thumbnails.background (Hugo mascot on a brand-color gradient, positioned bottom-right to stay clear of the dynamic text) and a new contribute/seo.mdx documenting today's setup plus stubs for structured-data/indexing config that future issues can expand. Also documents the new images/ folder in files-and-folders.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Closes #171.
Summary
og:title/og:description/og:image/twitter:*tags from each page's own frontmattertitle/description— no config needed, and not literally "no OpenGraph metadata at all" as the issue described. The real gap was the plain default background (flat brand-color gradient, no illustration).seo.thumbnails.background(images/og-background.png) — the Hugo mascot on a brand-color gradient, positioned bottom-right so it stays clear of the dynamic title/description text, which Mintlify always renders top-left.contribute/seo.mdx: documents the automatic per-page behavior, the new custom background, the existingseo.metatags.canonicalsetting, and stub sections for structured-data/organizationand indexing controls — left for future issues to expand, per direct instruction.images/folder (site-widedocs.json-referenced assets, distinct from per-topicmedia/and the fixed-filenamelogo/) incontribute/files-and-folders.md.contribute/seointo the Contribute tab, right afterconfigure-mintlify.Verification
markdownlint-cli2 contribute/seo.mdx contribute/files-and-folders.mdtools/verify-nav-paths.py config/nav-contribute.jsondocs.json/config/nav-contribute.jsonJSON validityog:image🤖 Generated with Claude Code