docs: add pluginOg and og-image to rspress docsite #2835
+338
−4
Conversation
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
✅ Deploy Preview for rspress-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR integrates the rspress-plugin-og package to enable dynamic Open Graph image generation for the Rspress documentation site. The plugin replaces the static OG image configuration previously used by rsbuild-plugin-open-graph.
Key Changes:
- Adds
rspress-plugin-ogdependency and configures it with the site domain - Removes static OG image URL from
pluginOpenGraphconfiguration (now handled dynamically bypluginOg) - Adds
titlefrontmatter to homepage markdown files for proper OG image generation - Disables SSG experimental worker mode due to function serialization incompatibility
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/rspress.config.ts | Imports and configures pluginOg, removes static OG image from pluginOpenGraph, and comments out SSG worker mode due to plugin incompatibility |
| website/package.json | Adds rspress-plugin-og as an npm alias dependency using @latest tag |
| website/docs/zh/index.md | Adds title: Rspress to frontmatter for OG image generation |
| website/docs/en/index.md | Adds title: Rspress to frontmatter and a heading after frontmatter |
| pnpm-lock.yaml | Lockfile updates for new rspress-plugin-og dependency and its transitive dependencies (sharp, ufo, etc.) |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Rsdoctor Bundle Diff Analysis📁 webPath:
📦 Download Diff Report: web Bundle Diff Generated by Rsdoctor GitHub Action |
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.
Summary
docs: add pluginOg and og-image to rspress docsite
Related Issue
#2835
Checklist