docs: optimize home page

Author: fu050409

docs/docs/en/index.md

@@ -5,13 +5,13 @@ hero:
   name: MateChat React
   text: AI scenario solution
   tagline: A frontend AI scenario solution UI library based on DevUI Design
-  # actions:
-  #   - theme: brand
-  #     text: Quick Start
-  #     link: /guide/start/introduction
-  #   - theme: alt
-  #     text: GitHub
-  #     link: https://github.com/DevCloudFE/matechat-react
+  actions:
+    # - theme: brand
+    #   text: Quick Start
+    #   link: /guide/start/introduction
+    - theme: alt
+      text: GitHub
+      link: https://github.com/DevCloudFE/matechat-react
   image:
     src: /matechat-icon.svg
 

docs/env.d.ts

@@ -1,4 +1,4 @@
-import * as path from "node:path";
+import path from "node:path";
 import { pluginPlayground } from "@rspress/plugin-playground";
 import { defineConfig } from "rspress/config";
 import GitCodeIcon from "./assets/gitcode.ts";
@@ -9,6 +9,10 @@ export default defineConfig({
   title: "MateChat React",
   icon: "/matechat-icon.svg",
   logo: "/matechat-icon.svg",
+  logoText: "MateChat React",
+  markdown: {
+    checkDeadLinks: true,
+  },
   lang: "en",
   locales: [
     {
@@ -39,6 +43,10 @@ export default defineConfig({
         content: "https://github.com/DevCloudFE/matechat-react",
       },
     ],
+    hideNavbar: "auto",
+    footer: {
+      message: "MIT Licensed | © 2025 DevCloudFE. All Rights Reserved.",
+    },
   },
   globalStyles: path.resolve(__dirname, "./docs/tailwind.css"),
   mediumZoom: {

docs/rspress.config.ts

@@ -0,0 +1,29 @@
+import { useLang } from "rspress/runtime";
+import {
+  HomeLayout as BasicHomeLayout,
+  Layout as BasicLayout,
+  //   getCustomMDXComponent,
+} from "rspress/theme";
+
+function HomeLayout() {
+  //   const { code: Code } = getCustomMDXComponent();
+  return <BasicHomeLayout />;
+}
+
+const Layout = () => {
+  const lang = useLang();
+  return (
+    <BasicLayout
+      beforeNav={
+        <div className="text-center from-sky-400 to-emerald-600 bg-gradient-to-r text-white font-bold py-1">
+          {lang === "en"
+            ? "🚧 MateChat React document is still under development"
+            : "🚧 MateChat React 文档仍在开发中"}
+        </div>
+      }
+    />
+  );
+};
+
+export default { HomeLayout, Layout };
+export * from "rspress/theme";

docs/theme/index.tsx

@@ -13,7 +13,7 @@
     "useDefineForClassFields": true,
     "allowImportingTsExtensions": true
   },
-  "include": ["docs", "theme", "rspress.config.ts", "env.d.ts"],
+  "include": ["docs", "theme", "rspress.config.ts"],
   "mdx": {
     "checkMdx": true
   }

docs/tsconfig.json

@@ -1,5 +1,5 @@
 import { execSync, spawn } from "node:child_process";
-import fs, { type WatchEventType } from "node:fs";
+import fs from "node:fs";
 import path from "node:path";
 import { createSpinner } from "archons";
 import chalk from "chalk";
@@ -80,7 +80,7 @@ function watchAndServe() {
 
   let lastBuildTime = Date.now();
 
-  fs.watch(srcDir, { recursive: true }, (eventType, filename) => {
+  fs.watch(srcDir, { recursive: true }, (_eventType, filename) => {
     if (!filename || isIgnoredFile(filename)) return;
     if (Date.now() - lastBuildTime < 1000) return;
 

scripts/docs-watch.ts

@@ -1,6 +1,6 @@
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);