Skip to content

docs: upgrade llms.txt and ssg-md#2927

Merged
SoonIter merged 4 commits intomainfrom
docs/custom-theme
Dec 25, 2025
Merged

docs: upgrade llms.txt and ssg-md#2927
SoonIter merged 4 commits intomainfrom
docs/custom-theme

Conversation

@SoonIter
Copy link
Copy Markdown
Member

@SoonIter SoonIter commented Dec 24, 2025

Summary

docs: upgrade llms.txt and ssg-md

Related Issue

close #2857

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings December 24, 2025 11:24
@netlify
Copy link
Copy Markdown

netlify bot commented Dec 24, 2025

Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit 0118bd8
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/694bce85a0136200081cef88
😎 Deploy Preview https://deploy-preview-2927--rspress-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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 upgrades the documentation for the llms.txt and SSG-MD features, providing comprehensive guides in both English and Chinese. The documentation explains what SSG-MD is, why it's needed, how it's implemented, and how to use it.

  • Adds extensive documentation content explaining the SSG-MD feature and its benefits for GEO (Generative Engine Optimization)
  • Includes detailed implementation examples showing React-to-Markdown rendering
  • Refactors the Layout component to use usePage() instead of usePageData()

Reviewed changes

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

File Description
website/docs/zh/guide/basic/ssg-md.mdx Adds comprehensive Chinese documentation for SSG-MD feature with examples, configuration, and warnings
website/docs/en/guide/basic/ssg-md.mdx Adds comprehensive English documentation for SSG-MD feature, mirroring the Chinese version
packages/core/src/theme/layout/Layout/index.tsx Refactors to use usePage() hook instead of usePageData() for better separation of concerns

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

@github-actions
Copy link
Copy Markdown
Contributor

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 9.3 MB +59.6 KB (0.6%)
node_md 1.1 MB 📈 +19.5 KB (+1.7%)
web 15.1 MB +66.9 KB (0.4%)
📋 Detailed Reports (Click to expand)

📁 node

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

📌 Baseline Commit: b93fade4d0 | PR: #2925

Metric Current Baseline Change
📊 Total Size 9.3 MB 9.2 MB +59.6 KB (0.6%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 9.3 MB 9.2 MB +59.6 KB (0.6%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: node Bundle Diff

📁 node_md

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

📌 Baseline Commit: b93fade4d0 | PR: #2925

Metric Current Baseline Change
📊 Total Size 1.1 MB 1.1 MB +19.5 KB (+1.7%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.1 MB 1.1 MB +19.5 KB (+1.7%)

📦 Download Diff Report: node_md Bundle Diff

📁 web

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

📌 Baseline Commit: b93fade4d0 | PR: #2925

Metric Current Baseline Change
📊 Total Size 15.1 MB 15.0 MB +66.9 KB (0.4%)
📄 JavaScript 14.4 MB 14.4 MB +57.4 KB (0.4%)
🎨 CSS 115.4 KB 115.4 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 526.5 KB 517.0 KB +9.5 KB (+1.8%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter enabled auto-merge (squash) December 24, 2025 12:00
@SoonIter SoonIter requested review from chenjiahan and removed request for chenjiahan December 24, 2025 12:00
@SoonIter SoonIter merged commit c03d863 into main Dec 25, 2025
10 checks passed
@SoonIter SoonIter deleted the docs/custom-theme branch December 25, 2025 03:54
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.

[Feature]: Support Converting MDX Components to Markdown in @rspress/plugin-llms

3 participants