feat: ssg-md by SoonIter · Pull Request #2666 · web-infra-dev/rspress

SoonIter · 2025-10-19T10:16:12Z

Summary

feat: md-ssg

// rspress.config.ts
defineConfig({
   llms: true
})

Related Issue

Checklist

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

netlify · 2025-10-19T10:16:19Z

✅ Deploy Preview for rspress-v2 ready!

Name	Link
🔨 Latest commit	`87b1e0d`
🔍 Latest deploy log	https://app.netlify.com/projects/rspress-v2/deploys/69086ebdef907f000890a975
😎 Deploy Preview	https://deploy-preview-2666--rspress-v2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

Copilot

Pull Request Overview

This PR implements a new "md-ssg" (Markdown Static Site Generation) feature that enables rendering React components to Markdown format during the build process. The implementation includes a custom React reconciler that converts React elements to Markdown strings, along with associated build configuration and remark plugins.

Key Changes:

Added custom React reconciler for rendering React components to Markdown
Implemented remark plugin for wrapping/filtering Markdown content with JSX
Created new build environment (node_md) for SSG-MD compilation

Reviewed Changes

Copilot reviewed 32 out of 33 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`website/rspress.config.ts`	Commented out pluginLlms
`vitest.workspace.ts`	Extended test file pattern to include `.tsx` files
`scripts/dictionary.txt`	Added MDSSG and SSGMD to dictionary, alphabetized entries
`packages/theme-default/src/logic/sideEffects.ts`	Added window existence check for SSR compatibility
`packages/theme-default/src/components/Toc/useDynamicToc.ts`	Added window existence check for SSR compatibility
`packages/theme-default/src/components/Toc/useActiveAnchor.ts`	Added window existence check and prefixed getComputedStyle with window
`packages/theme-default/src/components/SidebarMenu/useClickOutside.ts`	Added document existence check and simplified null check
`packages/theme-default/src/components/Sidebar/SidebarItem.tsx`	Added optional chaining for scrollIntoView
`packages/theme-default/src/components/ReadPercent/useReadPercent.ts`	Added window existence check for SSR compatibility
`packages/theme-default/src/components/NavHamburger/useNavScreen.ts`	Added window existence checks in open/close functions
`packages/runtime/src/hooks/useWindowSize.ts`	Added window existence check in useLayoutEffect
`packages/core/static/MediumZoom.tsx`	Added document check and prefixed setTimeout with window
`packages/core/src/runtime/ssrMdServerEntry.tsx`	New SSR entry point for MD rendering
`packages/core/src/runtime/App.tsx`	Added Content import and SSR_MD condition to render only Content
`packages/core/src/node/ssg-md/rsbuildPluginSSGMD.ts`	New Rsbuild plugin for SSG-MD build process
`packages/core/src/node/ssg-md/renderPages.ts`	Renders all pages to Markdown files
`packages/core/src/node/ssg-md/renderPage.ts`	Renders individual page to Markdown
`packages/core/src/node/ssg-md/remarkWrapMarkdown.ts`	Remark plugin for wrapping/filtering Markdown with JSX
`packages/core/src/node/ssg-md/remarkWrapMarkdown.test.ts`	Test suite for remarkWrapMarkdown plugin
`packages/core/src/node/ssg-md/react/render.ts`	Renders React elements to Markdown strings
`packages/core/src/node/ssg-md/react/render.test.tsx`	Tests for React-to-Markdown rendering
`packages/core/src/node/ssg-md/react/reconciler.ts`	Custom React reconciler for Markdown output
`packages/core/src/node/ssg-md/react/index.ts`	Exports renderToMarkdownString function
`packages/core/src/node/mdx/types.ts`	Added isSsgMd option to MdxLoaderOptions
`packages/core/src/node/mdx/remarkPlugins/link.ts`	Fixed dead link checking logic for cleanUrls handling
`packages/core/src/node/mdx/processor.ts`	Added isSsgMd parameter support
`packages/core/src/node/mdx/options.ts`	Configured MDX options for SSG-MD mode
`packages/core/src/node/mdx/loader.ts`	Added isSsgMd option and disabled cache for SSG-MD
`packages/core/src/node/initRsbuild.ts`	Configured node_md build environment and SSG-MD plugin
`packages/core/src/node/constants.ts`	Added SSG_MD constants
`packages/core/rslib.config.ts`	Added build config for react module
`packages/core/package.json`	Added dependencies and export path for _private/react

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Timeless0911

Merge first to avoid frequently resolve conflicts, PR descriptions and other fix or refactor of this PR should be performed later.

Copilot AI review requested due to automatic review settings October 19, 2025 10:16

github-actions Bot added the change: feat label Oct 19, 2025

Copilot AI reviewed Oct 19, 2025

View reviewed changes

Comment thread packages/core/src/node/ssg-md/react/render.ts Outdated

Comment thread packages/core/src/node/ssg-md/remarkWrapMarkdown.ts Outdated

Comment thread packages/core/src/node/initRsbuild.ts Outdated

SoonIter changed the title ~~feat: md-ssg~~ feat: ssg-md Oct 19, 2025

SoonIter force-pushed the syt/md-ssg branch 2 times, most recently from 5d46a69 to 1a2891e Compare October 22, 2025 11:27

SoonIter requested a review from Timeless0911 October 22, 2025 11:53

Timeless0911 reviewed Oct 22, 2025

View reviewed changes

Comment thread packages/shared/src/types/index.ts

Timeless0911 reviewed Oct 22, 2025

View reviewed changes

Comment thread packages/core/package.json

SoonIter force-pushed the syt/md-ssg branch 2 times, most recently from 83aa00e to 53dc3c0 Compare October 23, 2025 07:52

SoonIter force-pushed the syt/md-ssg branch from 53dc3c0 to 462037f Compare November 3, 2025 08:14

SoonIter added 2 commits November 3, 2025 16:15

chore: update

775a894

chore: upgrade

1dd2541

SoonIter force-pushed the syt/md-ssg branch from 462037f to 1dd2541 Compare November 3, 2025 08:15

SoonIter added 3 commits November 3, 2025 16:51

chore: update

6f43dad

chore: update

b1640a2

chore: update

87b1e0d

SoonIter requested a review from Timeless0911 November 4, 2025 09:03

Timeless0911 approved these changes Nov 4, 2025

View reviewed changes

SoonIter merged commit 1b7f6ff into main Nov 4, 2025
8 checks passed

SoonIter deleted the syt/md-ssg branch November 4, 2025 09:07

SoonIter mentioned this pull request Dec 8, 2025

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: ssg-md#2666

feat: ssg-md#2666
SoonIter merged 5 commits intomainfrom
syt/md-ssg

SoonIter commented Oct 19, 2025 •

edited

Loading

Uh oh!

netlify Bot commented Oct 19, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Timeless0911 left a comment •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

SoonIter commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Checklist

Uh oh!

netlify Bot commented Oct 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rspress-v2 ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Timeless0911 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

SoonIter commented Oct 19, 2025 •

edited

Loading

netlify Bot commented Oct 19, 2025 •

edited

Loading

Timeless0911 left a comment •

edited

Loading