Skip to content

fix(custom-head/frontmatter): frontmatter og:title and description priority over Rspress's own default tags#3215

Merged
SoonIter merged 3 commits intomainfrom
docs/fix-og-meta-property
Mar 12, 2026
Merged

fix(custom-head/frontmatter): frontmatter og:title and description priority over Rspress's own default tags#3215
SoonIter merged 3 commits intomainfrom
docs/fix-og-meta-property

Conversation

@SoonIter
Copy link
Copy Markdown
Member

Summary

  • Fix Open Graph meta tag examples in custom-head docs (both EN and ZH) to use property attribute instead of name, as required by the Open Graph protocol

Test plan

  • Visual review of the documentation changes

The Open Graph protocol requires `property` attribute (from RDFa) rather
than `name` for og: meta tags.
Copilot AI review requested due to automatic review settings March 11, 2026 12:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the “custom head tags” documentation examples to use the correct Open Graph <meta> attribute (property instead of name), aligning the narrative and frontmatter snippets with Open Graph conventions and the rest of the docs.

Changes:

  • Update the example <meta> tag from name="og:..." to property="og:..." in both EN and ZH guides.
  • Update the frontmatter head example to use property: og:* keys for Open Graph entries.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
website/docs/en/guide/advanced/custom-head.mdx Fix Open Graph meta tag examples to use property in both inline HTML and frontmatter head snippet.
website/docs/zh/guide/advanced/custom-head.mdx Same documentation correction for the Chinese guide.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Mar 11, 2026

Deploying rspress-v2 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0a5ef38
Status: ✅  Deploy successful!
Preview URL: https://c4ff6f3f.rspress-v2.pages.dev
Branch Preview URL: https://docs-fix-og-meta-property.rspress-v2.pages.dev

View logs

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 11, 2026

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 12.2 MB +24.0 B (0.0%)
web 16.1 MB +277.0 B (0.0%)
node_md 1.5 MB +48.0 B (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

Path: website/doc_build/diff-rsdoctor/node/rsdoctor-data.json

📌 Baseline Commit: e5e68ff243 | PR: #3213

Metric Current Baseline Change
📊 Total Size 12.2 MB 12.2 MB +24.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 12.2 MB 12.2 MB +24.0 B (0.0%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: node Bundle Diff

📁 web

Path: website/doc_build/diff-rsdoctor/web/rsdoctor-data.json

📌 Baseline Commit: e5e68ff243 | PR: #3213

Metric Current Baseline Change
📊 Total Size 16.1 MB 16.1 MB +277.0 B (0.0%)
📄 JavaScript 15.8 MB 15.8 MB +277.0 B (0.0%)
🎨 CSS 120.3 KB 120.3 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 165.0 KB 165.0 KB 0

📦 Download Diff Report: web Bundle Diff

📁 node_md

Path: website/doc_build/diff-rsdoctor/node_md/rsdoctor-data.json

📌 Baseline Commit: e5e68ff243 | PR: #3213

Metric Current Baseline Change
📊 Total Size 1.5 MB 1.5 MB +48.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.5 MB 1.5 MB +48.0 B (0.0%)

📦 Download Diff Report: node_md Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter enabled auto-merge (squash) March 11, 2026 12:19
@SoonIter SoonIter requested a review from Timeless0911 March 11, 2026 12:19
@SoonIter SoonIter changed the title docs: use property instead of name for Open Graph meta tags docs(typo): use property instead of name for Open Graph meta tags Mar 11, 2026
Timeless0911
Timeless0911 previously approved these changes Mar 11, 2026
@SoonIter SoonIter changed the title docs(typo): use property instead of name for Open Graph meta tags fix(custom-head/frontmatter): frontmatter og:title and description priority over Rspress's own default tags Mar 11, 2026
@SoonIter SoonIter merged commit c65c74a into main Mar 12, 2026
6 checks passed
@SoonIter SoonIter deleted the docs/fix-og-meta-property branch March 12, 2026 03:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants