Merge pull request #297 from Mister-Hope/master

docs: update docs

.github/workflows/docs-test.yml

@@ -14,14 +14,15 @@ jobs:
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
-        with:
-          run_install: true
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: pnpm
 
+      - name: Install deps
+        run: pnpm install --frozen-lockfile
+
       - name: Build docs
         run: pnpm docs:build

.github/workflows/docs.yml

@@ -16,15 +16,16 @@ jobs:
 
       - name: Install pnpm
         uses: pnpm/action-setup@v2
-        with:
-          run_install: true
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           cache: pnpm
 
+      - name: Install deps
+        run: pnpm install --frozen-lockfile
+
       - name: Build docs
         run: pnpm docs:build
 

.prettierignore

@@ -2,3 +2,5 @@
 **/.vuepress/.temp/**
 **/.vuepress/dist/**
 **/node_modules/**
+
+docs/.vuepress/public/js/gtag.js

docs/.vuepress/components/AdPage.vue

@@ -1,26 +1,21 @@
-<template>
-  <div
-    :class="`wwads-cn wwads-${mode} page-wwads-${content}`"
-    data-id="274"
-  ></div>
-</template>
-<script lang="ts">
-import { defineComponent } from "vue";
-
-export default defineComponent({
-  props: {
-    mode: {
-      type: String,
-      default: "horizontal",
-    },
-    content: {
-      type: String,
-      default: "",
-    },
+<script setup lang="ts">
+defineProps({
+  mode: {
+    type: String,
+    default: "horizontal",
+  },
+  content: {
+    type: String,
+    default: "",
   },
 });
 </script>
-<style>
+
+<template>
+  <div :class="`wwads-cn wwads-${mode} page-wwads-${content}`" data-id="274" />
+</template>
+
+<style lang="scss">
 @use "vuepress-shared/styles/wrapper";
 
 .page-wwads-content {

docs/.vuepress/components/ColorIcon.ts

@@ -4,5 +4,5 @@ export const ColorIcon: FunctionalComponent<{ icon: string }> = ({ icon }) =>
   h(
     "svg",
     { class: "icon svg-icon", "aria-hidden": "true" },
-    h("use", { "xlink:href": `#icon-${icon}` }),
+    h("use", { "xlink:href": `#icon-${icon}` })
   );

docs/.vuepress/components/HomePage.vue

@@ -1,11 +1,12 @@
+<script setup lang="ts">
+import HopeHomePage from "vuepress-theme-hope/components/HomePage.js";
+import AdPage from "./AdPage.vue";
+</script>
+
 <template>
   <HopeHomePage>
     <template #center>
       <AdPage content="content" />
     </template>
   </HopeHomePage>
 </template>
-<script setup lang="ts">
-import HopeHomePage from "vuepress-theme-hope/components/HomePage.js";
-import AdPage from "./AdPage.vue";
-</script>

docs/.vuepress/components/NormalPage.vue

@@ -1,11 +1,12 @@
+<script setup lang="ts">
+import NormalPage from "vuepress-theme-hope/components/NormalPage.js";
+import AdPage from "./AdPage.vue";
+</script>
+
 <template>
   <NormalPage>
     <template #contentBefore>
       <AdPage content="content" />
     </template>
   </NormalPage>
 </template>
-<script setup lang="ts">
-import NormalPage from "vuepress-theme-hope/components/NormalPage.js";
-import AdPage from "./AdPage.vue";
-</script>

docs/.vuepress/config.ts

@@ -1,6 +1,5 @@
 import { getDirname, path } from "@vuepress/utils";
 import { defineUserConfig } from "vuepress";
-import { docsearchPlugin } from "@vuepress/plugin-docsearch";
 import theme from "./theme.js";
 
 const __dirname = getDirname(import.meta.url);
@@ -64,32 +63,6 @@ export default defineUserConfig({
 
   theme,
 
-  plugins: [
-    docsearchPlugin({
-      appId: "8FRYEU6KK8",
-      apiKey: "84f513df1e83406ba42179da778d87b4",
-      indexName: "dromara-fast-request",
-      locales: {
-        "/": {
-          placeholder: "搜索文档",
-          translations: {
-            button: {
-              buttonText: "搜索文档",
-            },
-          },
-        },
-        "/en": {
-          placeholder: "Search Documentation",
-          translations: {
-            button: {
-              buttonText: "Search Documentation",
-            },
-          },
-        },
-      },
-    }),
-  ],
-
   pagePatterns: ["**/*.md", "!*.snippet.md", "!.vuepress", "!node_modules"],
 
   alias: {

docs/.vuepress/theme.ts

@@ -52,7 +52,6 @@ export default hopeTheme(
       components: {
         components: ["Badge", "BiliBili", "SiteInfo", "VPCard"],
         rootComponents: {
-          addThis: "ra-617a48e0d1826cc4",
           notice: [
             {
               path: "/",
@@ -88,6 +87,22 @@ export default hopeTheme(
         },
       },
 
+      docsearch: {
+        appId: "8FRYEU6KK8",
+        apiKey: "84f513df1e83406ba42179da778d87b4",
+        indexName: "dromara-fast-request",
+        locales: {
+          "/en/": {
+            placeholder: "Search Documentation",
+            translations: {
+              button: {
+                buttonText: "Search Documentation",
+              },
+            },
+          },
+        },
+      },
+
       mdEnhance: {
         align: true,
         chart: true,

package.json

@@ -10,18 +10,18 @@
     "docs:clean-dev": "vuepress dev docs --no-cache",
     "packages:update": "pnpm dlx vp-update"
   },
-  "packageManager": "pnpm@8.11.0",
+  "packageManager": "pnpm@8.13.1",
   "dependencies": {
     "@vuepress/client": "2.0.0-rc.0",
     "@vuepress/plugin-docsearch": "2.0.0-rc.0",
     "@vuepress/utils": "2.0.0-rc.0",
     "chart.js": "^4.4.1",
-    "vue": "^3.3.10",
+    "vue": "^3.4.1",
     "vue-router": "^4.2.5",
     "vuepress": "2.0.0-rc.0",
-    "vuepress-theme-hope": "2.0.0-rc.2"
+    "vuepress-theme-hope": "2.0.0-rc.10"
   },
   "devDependencies": {
-    "prettier": "3.1.0"
+    "prettier": "3.1.1"
   }
 }