fix: apply replaceRules in object frontmatter

e2e/fixtures/replace-rules/doc/_meta.json

@@ -0,0 +1,6 @@
+[
+  {
+    "text": "foo-meta",
+    "link": "/foo/"
+  }
+]

e2e/fixtures/replace-rules/doc/foo/content.mdx

@@ -0,0 +1 @@
+## foo-h2

e2e/fixtures/replace-rules/doc/foo/index.mdx

@@ -0,0 +1,9 @@
+---
+title: foo-title
+---
+
+import Content from './content.mdx';
+
+<Content />
+
+foo-content

e2e/fixtures/replace-rules/doc/index.mdx

@@ -1,3 +1,10 @@
-import Content from './content.mdx';
+---
+pageType: home
 
-<Content />
+hero:
+  name: foo-hero
+  text: |
+    Lightning Fast
+    Static Site Generator
+  tagline: Simple, efficient and easy to extend
+---

e2e/fixtures/replace-rules/rspress.config.ts

@@ -5,8 +5,8 @@ export default defineConfig({
   root: path.join(__dirname, 'doc'),
   replaceRules: [
     {
-      search: /content/g,
-      replace: 'h1',
+      search: /foo/g,
+      replace: 'bar',
     },
   ],
 });

e2e/tests/replace-rules.test.ts

@@ -21,8 +21,39 @@ test.describe('replace-rules test', async () => {
 
   test('Index page', async ({ page }) => {
     await page.goto(`http://localhost:${appPort}`);
-    const h1 = await page.$('h1');
-    const content = await page.evaluate(h1 => h1?.textContent, h1);
-    expect(content).toContain('h1');
+
+    // replace text in _meta.json
+    const nav = await page.$('.rspress-nav-menu');
+    const navContent = await page.evaluate(nav => nav?.textContent, nav);
+
+    // replace text in object frontmatter
+    const hero = await page.$('h1');
+    const heroContent = await page.evaluate(hero => hero?.textContent, hero);
+
+    expect(navContent).toEqual('bar-meta');
+    expect(heroContent).toEqual('bar-hero');
+  });
+
+  test('Foo page', async ({ page }) => {
+    await page.goto(`http://localhost:${appPort}/foo`);
+
+    // text in string frontmatter
+    const title = await page.$('title');
+    const titleContent = await page.evaluate(
+      title => title?.textContent,
+      title,
+    );
+
+    // replace text in shared mdx content
+    const h2 = await page.$('h2');
+    const h2Content = await page.evaluate(h2 => h2?.textContent, h2);
+
+    // replace text in mdx content
+    const text = await page.$('.rspress-doc p');
+    const textContent = await page.evaluate(text => text?.textContent, text);
+
+    expect(titleContent).toEqual('bar-title');
+    expect(h2Content).toEqual('bar-h2#');
+    expect(textContent).toEqual('bar-content');
   });
 });

packages/core/src/node/runtimeModule/siteData/extractPageData.ts

@@ -14,6 +14,21 @@ import { importStatementRegex } from '@/node/constants';
 import type { RouteService } from '@/node/route/RouteService';
 import { applyReplaceRules } from '@/node/utils/applyReplaceRules';
 
+export function applyReplaceRulesToNestedObject(
+  obj,
+  replaceRules: ReplaceRule[],
+) {
+  for (const key in obj) {
+    if (typeof obj[key] === 'string') {
+      obj[key] = applyReplaceRules(obj[key], replaceRules);
+    } else if (typeof obj[key] === 'object') {
+      obj[key] = applyReplaceRulesToNestedObject(obj[key], replaceRules);
+    }
+  }
+
+  return obj;
+}
+
 export async function extractPageData(
   replaceRules: ReplaceRule[],
   alias: Record<string, string | string[]>,
@@ -48,11 +63,7 @@ export async function extractPageData(
       );
 
       // 1. Replace rules for frontmatter & content
-      Object.keys(frontmatter).forEach(key => {
-        if (typeof frontmatter[key] === 'string') {
-          frontmatter[key] = applyReplaceRules(frontmatter[key], replaceRules);
-        }
-      });
+      applyReplaceRulesToNestedObject(frontmatter, replaceRules);
 
       const { flattenContent } = await flattenMdxContent(
         applyReplaceRules(strippedFrontMatter, replaceRules),

packages/document/docs/en/api/config/config-basic.mdx

@@ -434,3 +434,21 @@ export default {
   },
 };
 ```
+
+## replaceRules
+
+- Type: `{ search: string | RegExp; replace: string; }[]`
+- Default: `[]`
+
+You can set text replacement rules for the entire site through `replaceRules`. The rules will apply to everything including `_meta.json` files, frontmatter configurations, and document content and titles.
+
+```ts title="rspress.config.ts"
+export default {
+  replaceRules: [
+    {
+      search: /foo/g,
+      replace: 'bar',
+    },
+  ],
+};
+```

packages/document/docs/zh/api/config/config-basic.mdx

@@ -433,3 +433,21 @@ export default {
   },
 };
 ```
+
+## replaceRules
+
+- Type: `{ search: string | RegExp; replace: string; }[]`
+- Default: `[]`
+
+你可以通过 `replaceRules` 来对整个站点设置文本替换规则，规则会作用于包括 `_meta.json` 文件、frontmatter 配置以及文档内容和标题等所有内容。
+
+```ts title="rspress.config.ts"
+export default {
+  replaceRules: [
+    {
+      search: /foo/g,
+      replace: 'bar',
+    },
+  ],
+};
+```