Skip to content

docs: add documentation for markdown.crossCompilerCache option #2979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
SoonIter merged 1 commit into from
Jan 9, 2026
Merged

docs: add documentation for markdown.crossCompilerCache option #2979

SoonIter merged 1 commit into from
Jan 9, 2026

Conversation

@SoonIter
Copy link
Member

@SoonIter SoonIter commented Jan 8, 2026 •
edited
Loading

Summary

Add documentation for the markdown.crossCompilerCache configuration option in both English and Chinese.

Related Issue

#2256

Checklist

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

Changes Made

Added documentation for markdown.crossCompilerCache in:

  • website/docs/en/api/config/config-build.mdx
  • website/docs/zh/api/config/config-build.mdx

Documentation Details

The crossCompilerCache option was introduced in PR #2256 but was not documented at the time. This PR adds the missing documentation with:

  • Type: boolean
  • Default: true
  • Description: Enables cross-compiler cache for MDX compilation during production builds, caching parsing results across web and node compilers
  • Performance benefit: Approximately 10% faster build times
  • Note: Only takes effect in production builds, inspired by Docusaurus

This PR was written using Vibe Kanban

@SoonIter
已完成！我在英文和中文的 config-build.mdx 文件中添加了 markdown.crossCompilerCache …
a8a6fd8 
…的文档。

**添加的内容包括：**

1. **英文文档** (`website/docs/en/api/config/config-build.mdx:270-287`)
2. **中文文档** (`website/docs/zh/api/config/config-build.mdx:272-289`)

**文档说明：**
- 类型：`boolean`
- 默认值：`true`
- 功能：在 `rspress build` 时启用跨编译器缓存，通过在多个编译器（web 和 node）之间缓存 MDX 解析结果来加速生产环境构建
- 效果：构建时间减少约 10%
- 限制：仅在生产环境构建时生效
- 灵感来源：Docusaurus
Copilot AI review requested due to automatic review settings January 8, 2026 17:58
@netlify
Copy link

netlify bot commented Jan 8, 2026 •
edited
Loading

✅ Deploy Preview for rspress-v2 ready!

Name Link
🔨 Latest commit a8a6fd8
🔍 Latest deploy log https://app.netlify.com/projects/rspress-v2/deploys/695ff0538d19b00007314c84
😎 Deploy Preview https://deploy-preview-2979--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.

@SoonIter SoonIter changed the title 给 markdown.crossCompilerCache 增加文档 (vibe-kanban) docs: add documentation for markdown.crossCompilerCache option Jan 8, 2026
Copilot AI reviewed Jan 8, 2026
View reviewed changes
Copy link
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 adds documentation for the markdown.crossCompilerCache configuration option in both Chinese and English versions of the Rspress documentation. The option enables cross-compiler caching during production builds to improve build performance.

  • Adds comprehensive documentation for the crossCompilerCache option including type definition, default value, description, and usage examples
  • Documents that the feature speeds up production builds by approximately 10% by caching MDX parsing results across web and node compilers
  • Notes that the feature is inspired by Docusaurus and only takes effect in production builds

Reviewed changes

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

File Description
website/docs/zh/api/config/config-build.mdx Adds Chinese documentation for the markdown.crossCompilerCache configuration option
website/docs/en/api/config/config-build.mdx Adds English documentation for the markdown.crossCompilerCache configuration option

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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 8, 2026

Rsdoctor Bundle Diff Analysis

Found 3 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Change
node 9.7 MB +7.6 KB (0.1%)
node_md 1.2 MB +2.3 KB (0.2%)
web 15.5 MB +7.7 KB (0.0%)
📋 Detailed Reports (Click to expand)

📁 node

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

📌 Baseline Commit: ddd2a6c9ad | PR: #2971

Metric Current Baseline Change
📊 Total Size 9.7 MB 9.7 MB +7.6 KB (0.1%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 9.7 MB 9.7 MB +7.6 KB (0.1%)
📁 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: ddd2a6c9ad | PR: #2971

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

📦 Download Diff Report: node_md Bundle Diff

📁 web

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

📌 Baseline Commit: ddd2a6c9ad | PR: #2971

Metric Current Baseline Change
📊 Total Size 15.5 MB 15.5 MB +7.7 KB (0.0%)
📄 JavaScript 14.8 MB 14.8 MB +6.5 KB (0.0%)
🎨 CSS 130.2 KB 130.2 KB 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 562.7 KB 561.6 KB +1.1 KB (0.2%)

📦 Download Diff Report: web Bundle Diff

Generated by Rsdoctor GitHub Action

@SoonIter SoonIter requested a review from Timeless0911 January 9, 2026 05:00
@SoonIter SoonIter enabled auto-merge (squash) January 9, 2026 05:00
@SoonIter SoonIter merged commit 8b58028 into main Jan 9, 2026
16 checks passed
@SoonIter SoonIter deleted the syt_vk/2486-markdown-crossco branch January 9, 2026 05:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Timeless0911 Timeless0911 Timeless0911 approved these changes

Assignees

No one assigned

Labels

change: docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SoonIter @Timeless0911