Merge branch 'main' into renovate/nrwl-monorepo

web-infra-dev · Apr 23, 2024 · 6ec9efd · 6ec9efd
2 parents aae5062 + fb8eb1c
commit 6ec9efd
Show file tree

Hide file tree

Showing 45 changed files with 800 additions and 497 deletions.
diff --git a/.changeset/real-cobras-double.md → .changeset/plenty-birds-matter.md b/.changeset/real-cobras-double.md → .changeset/plenty-birds-matter.md
@@ -2,4 +2,4 @@
 "@rspress/theme-default": patch
 ---
 
-fix: remove invalid `className`
+hero use align-items
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -41,3 +41,6 @@ jobs:
 
       - name: Lint
         run: pnpm run lint
+
+      - name: Check Dependency Version
+        run: pnpm run check-dependency-version
diff --git a/e2e/fixtures/custom-plugin/package.json b/e2e/fixtures/custom-plugin/package.json
@@ -11,8 +11,8 @@
     "@rspress/plugin-playground": "workspace:*",
     "@rspress/plugin-preview": "workspace:*",
     "@rspress/shared": "workspace:*",
-    "react": "^18",
-    "react-dom": "^18",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-transition-group": "4.4.5",
     "rspress": "workspace:*",
     "solid-js": "^1.8.12"

diff --git a/e2e/fixtures/modern-js/package.json b/e2e/fixtures/modern-js/package.json
@@ -33,9 +33,5 @@
     "react-dom": "^18.2.0",
     "typescript": "^5"
   },
-  "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
-  },
   "sideEffects": []
 }
diff --git a/e2e/fixtures/plugin-preview/package.json b/e2e/fixtures/plugin-preview/package.json
@@ -11,8 +11,8 @@
     "@rspress/plugin-playground": "workspace:*",
     "@rspress/plugin-preview": "workspace:*",
     "@rspress/shared": "workspace:*",
-    "react": "^18",
-    "react-dom": "^18",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "react-transition-group": "4.4.5",
     "rspress": "workspace:*",
     "solid-js": "^1.8.12"

diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
     "changeset": "changeset",
     "prepare": "npm run build && husky install",
     "check-spell": "npx cspell",
+    "check-dependency-version": "check-dependency-version-consistency . --dep-type devDependencies",
     "dev": "cross-env NX_DAEMON=false NX_REJECT_UNKNOWN_LOCAL_CACHE=0 nx run-many -t dev --exclude @rspress-fixture/*",
     "build": "cross-env NX_DAEMON=false NX_REJECT_UNKNOWN_LOCAL_CACHE=0 nx run-many -t build --exclude @rspress-fixture/*",
     "test": "pnpm test:unit && pnpm test:e2e",
@@ -25,6 +26,9 @@
   "lint-staged": {
     "*.{ts,tsx,js,jsx,mjs,cjs}": [
       "biome lint . --diagnostic-level=warn"
+    ],
+    "package.json": [
+      "pnpm run check-dependency-version"
     ]
   },
   "workspaces": {
@@ -36,6 +40,7 @@
     ]
   },
   "devDependencies": {
+    "check-dependency-version-consistency": "^4.1.0",
     "@biomejs/biome": "1.5.3",
     "@changesets/cli": "^2.27.1",
     "@manypkg/get-packages": "^2.2.0",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rspress",
-  "version": "1.18.2",
+  "version": "1.18.3",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -46,11 +46,11 @@
   },
   "devDependencies": {
     "@types/jest": "~29.2.4",
-    "@types/node": "~16.11.7",
-    "@types/react": "~18.0.26",
-    "rimraf": "~3.0.2",
+    "@types/node": "^18.11.17",
+    "@types/react": "^18",
+    "rimraf": "^3.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "~5.0.4"
+    "typescript": "^5"
   },
   "sideEffects": [],
   "publishConfig": {

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rspress/core",
-  "version": "1.18.2",
+  "version": "1.18.3",
   "description": "The Rspress Documentation Framework",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -93,19 +93,19 @@
     "@modern-js/plugin-tailwindcss": "2.49.0",
     "@modern-js/tsconfig": "2.49.0",
     "@types/body-scroll-lock": "^3.1.0",
-    "@types/hast": "^2.3.4",
+    "@types/hast": "3.0.3",
     "@types/html-to-text": "^8.1.1",
-    "@types/jest": "^26.0.9",
-    "@types/lodash-es": "^4.17.6",
+    "@types/jest": "~29.2.4",
+    "@types/lodash-es": "^4.17.8",
     "@types/mdast": "^3.0.10",
-    "@types/node": "^14",
+    "@types/node": "^18.11.17",
     "@types/nprogress": "^0.2.0",
     "@types/react": "^18",
     "@types/react-dom": "^18",
     "@types/yaml-front-matter": "^4.1.0",
     "rimraf": "^3.0.2",
     "typescript": "^5",
-    "vitest": "0.33.0",
+    "vitest": "0.34.1",
     "webpack": "^5.88.1"
   },
   "sideEffects": [

diff --git a/packages/core/src/runtime/App.tsx b/packages/core/src/runtime/App.tsx
@@ -37,9 +37,7 @@ export async function initPageData(routePath: string): Promise<PageData> {
     const extractPageInfo = siteData.pages.find(page => {
       const normalize = (p: string) =>
         // compat the path that has no / suffix and ignore case
-        p
-          .replace(/\/$/, '')
-          .toLowerCase();
+        p.replace(/\/$/, '').toLowerCase();
       return isEqualPath(normalize(page.routePath), normalize(routePath));
     });
 
@@ -81,7 +79,7 @@ export async function initPageData(routePath: string): Promise<PageData> {
       frontmatter: {},
       title: '404',
       toc: [],
-      version: '',
+      version: siteData.multiVersion.default || '',
       _filepath: '',
       _relativePath: '',
     },

diff --git a/packages/create-rspress/package.json b/packages/create-rspress/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-rspress",
-  "version": "1.18.2",
+  "version": "1.18.3",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -22,13 +22,13 @@
   },
   "devDependencies": {
     "@types/jest": "~29.2.4",
-    "@types/node": "~16.11.7",
+    "@types/node": "^18.11.17",
     "@types/prompts": "^2.4.4",
-    "@types/react": "~18.0.26",
+    "@types/react": "^18",
     "@types/fs-extra": "11.0.4",
-    "rimraf": "~3.0.2",
+    "rimraf": "^3.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "~5.0.4",
+    "typescript": "^5",
     "cac": "6.7.14",
     "chalk": "5.3.0",
     "fs-extra": "11.2.0",

diff --git a/packages/document/docs/en/api/config/config-frontmatter.mdx b/packages/document/docs/en/api/config/config-frontmatter.mdx
@@ -50,7 +50,7 @@ import PageType from '@en/fragments/page-type';
 The hero config for the home page. It has the following types:
 
 ```ts
-export interface Hero {
+interface Hero {
   name: string;
   text: string;
   tagline: string;
@@ -81,7 +81,7 @@ pageType: home
 
 hero:
   name: Rspress
-  text: A documentation solution
+  text: A Documentation Solution
   tagline: A modern documentation development technology stack
   titleSuffix: '- Rspack-based Static Site Generator'
   actions:
@@ -94,6 +94,19 @@ hero:
 ---
 ```
 
+When setting `hero.text`, you can use the `|` symbol in YAML to manually control line breaks:
+
+```yaml
+---
+pageType: home
+
+hero:
+  name: Rspress
+  text: |
+    A Documentation
+    Solution
+```
+
 Or you can use `HTML` to specify the hero config for the page:
 
 ```yaml
@@ -102,7 +115,7 @@ pageType: home
 
 hero:
   name: <span class="hero-name">Rspress</span>
-  text: <span class="hero-text">A documentation solution</span>
+  text: <span class="hero-text">A Documentation Solution</span>
   tagline: <span class="hero-tagline">A modern documentation development technology stack</span>
   actions:
     - theme: brand
@@ -122,7 +135,7 @@ hero:
 features config of the `home` page. It has the following types:
 
 ```ts
-export interface Feature {
+interface Feature {
   title: string;
   details: string;
   icon: string;

diff --git a/packages/document/docs/en/fragments/internal-components.mdx b/packages/document/docs/en/fragments/internal-components.mdx
@@ -31,7 +31,7 @@ interface BadgeProps {
 
 ## Helmet
 
-It is generally used to set custom head content in documents (using `react-helmet-async` at the underlying level). The usage is as follows:
+It is generally used to set custom head content in documents (based on [react-helmet-async](https://www.npmjs.com/package/react-helmet-async)). The usage is as follows:
 
 ```tsx title="index.tsx"
 // Below is a custom component, you can import it into your document
@@ -40,7 +40,7 @@ import { Helmet } from 'rspress/runtime';
 function App() {
   return (
     <Helmet>
-      <meta property="og:description"  value="Out-of-box Rspack build tools">
+      <meta property="og:description" value="Out-of-box Rspack build tools" />
     </Helmet>
   );
 }
@@ -53,7 +53,7 @@ Feature component in Hero page, look [the effect in this website](/).
 ```tsx
 import { HomeFeature } from 'rspress/theme';
 
-export interface Feature {
+interface Feature {
   title: string;
   details: string;
   icon: string;
@@ -72,7 +72,7 @@ Hero component in Hero page.
 ```tsx
 import { HomeHero } from 'rspress/theme';
 
-export interface Hero {
+interface Hero {
   name: string;
   text: string;
   tagline: string;
@@ -140,7 +140,7 @@ interface Group {
   items: GroupItem[];
 }
 
-export interface OverviewProps {
+interface OverviewProps {
   // content before data rendering
   content?: React.ReactNode;
   // data

diff --git a/packages/document/docs/en/guide/advanced/custom-theme.mdx b/packages/document/docs/en/guide/advanced/custom-theme.mdx
@@ -62,6 +62,10 @@ const Layout = () => (
     beforeDoc={<div>beforeDoc</div>}
     /* Doc page end */
     afterDoc={<div>afterDoc</div>}
+    /* Doc content front */
+    beforeDocContent={<div>beforeDocContent</div>}
+    /* Doc content end */
+    afterDocContent={<div>afterDocContent</div>}
     /* Before the nav bar */
     beforeNav={<div>beforeNav</div>}
     /* Before the title of the nav bar in the upper left corner */

diff --git a/packages/document/docs/zh/api/config/config-frontmatter.mdx b/packages/document/docs/zh/api/config/config-frontmatter.mdx
@@ -50,7 +50,7 @@ import PageType from '@zh/fragments/page-type';
 `home` 页面的 hero 配置。它有以下类型：
 
 ```ts
-export interface Hero {
+interface Hero {
   name: string;
   text: string;
   tagline: string;
@@ -94,6 +94,19 @@ hero:
 ---
 ```
 
+在设置 `hero.text` 时，你可以使用 YAML 的 `|` 符号来手动控制换行：
+
+```yaml
+---
+pageType: home
+
+hero:
+  name: Rspress
+  text: |
+    文档工程
+    解决方案
+```
+
 或者你也可以用 `HTML` 来指定页面的 hero config：
 
 ```yaml
@@ -122,7 +135,7 @@ hero:
 `home` 页面的功能配置。它有以下类型：
 
 ```ts
-export interface Feature {
+interface Feature {
   title: string;
   details: string;
   icon: string;

diff --git a/packages/document/docs/zh/fragments/internal-components.mdx b/packages/document/docs/zh/fragments/internal-components.mdx
@@ -31,7 +31,7 @@ interface BadgeProps {
 
 ## Helmet
 
-一般用于在文档中设置自定义 head 内容(底层使用 `react-helmet-async`)。使用方法如下：
+一般用于在文档中设置自定义 head 内容（基于 [react-helmet-async](https://www.npmjs.com/package/react-helmet-async)）。使用方法如下：
 
 ```tsx title="index.tsx"
 // 以下为一个自定义组件，你可以将其引入到文档中
@@ -40,7 +40,7 @@ import { Helmet } from 'rspress/runtime';
 function App() {
   return (
     <Helmet>
-      <meta property="og:description"  value="Out-of-box Rspack build tools">
+      <meta property="og:description" value="Out-of-box Rspack build tools" />
     </Helmet>
   );
 }
@@ -53,7 +53,7 @@ Home 页面 Feature 组件，查看[本站的效果](/zh/)
 ```tsx
 import { HomeFeature } from 'rspress/theme';
 
-export interface Feature {
+interface Feature {
   title: string;
   details: string;
   icon: string;
@@ -73,7 +73,7 @@ Home 页面 Hero 组件
 ```tsx
 import { HomeHero } from 'rspress/theme';
 
-export interface Hero {
+interface Hero {
   name: string;
   text: string;
   tagline: string;
@@ -141,7 +141,7 @@ interface Group {
   items: GroupItem[];
 }
 
-export interface OverviewProps {
+interface OverviewProps {
   // 预览部分上方的内容
   content?: React.ReactNode;
   // 预览数据

diff --git a/packages/document/docs/zh/guide/advanced/custom-theme.mdx b/packages/document/docs/zh/guide/advanced/custom-theme.mdx
@@ -62,6 +62,10 @@ const Layout = () => (
     beforeDoc={<div>beforeDoc</div>}
     /* 正文页最后面 */
     afterDoc={<div>afterDoc</div>}
+    /* 文档内容前面 */
+    beforeDocContent={<div>beforeDocContent</div>}
+    /* 文档内容后面 */
+    afterDocContent={<div>afterDocContent</div>}
     /* 导航栏之前 */
     beforeNav={<div>beforeNav</div>}
     /* 左上角导航栏标题之前 */

diff --git a/packages/document/package.json b/packages/document/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@rspress/docs",
-  "version": "1.18.2",
+  "version": "1.18.3",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -20,7 +20,7 @@
   "devDependencies": {
     "@documate/documate": "^0.1.0",
     "@documate/react": "0.2.1",
-    "@types/react": "18.2.0",
+    "@types/react": "^18",
     "framer-motion": "10.18.0",
     "rsbuild-plugin-google-analytics": "^1.0.0",
     "rsbuild-plugin-open-graph": "^1.0.0",