enhance

LuxDL · Jan 21, 2025 · 7407d6a · 7407d6a
1 parent cf6805f
commit 7407d6a
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 8 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -1,10 +1,11 @@
 {
   "devDependencies": {
+    "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.12.1",
     "@types/d3-format": "^3.0.4",
-    "@types/node": "^22.10.5",
+    "@types/node": "^22.10.7",
     "markdown-it": "^14.1.0",
     "markdown-it-mathjax3": "^4.3.2",
-    "vitepress": "^1.5.0",
+    "vitepress": "^1.6.1",
     "vitepress-plugin-tabs": "^0.5.0"
   },
   "scripts": {

diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts
@@ -40,7 +40,21 @@ export default defineConfig({
   vite: {
     build: {
       assetsInlineLimit: 0, // so we can tell whether we have created inlined images or not, we don't let vite inline them
-    }
+    },
+    optimizeDeps: {
+      exclude: [ 
+        '@nolebase/vitepress-plugin-enhanced-readabilities/client',
+        'vitepress',
+        '@nolebase/ui',
+      ], 
+    }, 
+    ssr: { 
+      noExternal: [ 
+        // If there are other packages that need to be processed by Vite, you can add them here.
+        '@nolebase/vitepress-plugin-enhanced-readabilities',
+        '@nolebase/ui',
+      ], 
+    },
   },
 
   markdown: {

diff --git a/docs/src/.vitepress/theme/index.ts b/docs/src/.vitepress/theme/index.ts
@@ -1,6 +1,13 @@
 // .vitepress/theme/index.ts
 import { h } from 'vue'
 import type { Theme } from 'vitepress'
+import { 
+  NolebaseEnhancedReadabilitiesMenu, 
+  NolebaseEnhancedReadabilitiesScreenMenu, 
+} from '@nolebase/vitepress-plugin-enhanced-readabilities/client'
+
+import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css'
+
 import DefaultTheme from 'vitepress/theme'
 import AsideTrustees from '../../components/AsideTrustees.vue'
 import VersionPicker from "../../components/VersionPicker.vue"
@@ -15,7 +22,12 @@ export default {
   Layout() {
     return h(DefaultTheme.Layout, null, {
       'aside-ads-before': () => h(AsideTrustees),
-      'nav-bar-content-after': () => h(StarUs),
+      'nav-bar-content-after': () => [
+        h(StarUs),
+        h(NolebaseEnhancedReadabilitiesMenu), // Enhanced Readabilities menu
+      ],
+      // A enhanced readabilities menu for narrower screens (usually smaller than iPad Mini)
+      'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu),
     })
   },
   enhanceApp({ app, router, siteData }) {

diff --git a/template/package.json b/template/package.json
@@ -5,11 +5,12 @@
     "docs:preview": "vitepress preview build/.documenter"
   },
   "dependencies": {
-    "@shikijs/transformers": "^1.1.7",
+    "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.12.1",
+    "@shikijs/transformers": "^2.0.3",
     "markdown-it": "^14.1.0",
     "markdown-it-footnote": "^4.0.0",
     "markdown-it-mathjax3": "^4.3.2",
-    "vitepress": "^1.5.0",
+    "vitepress": "^1.6.1",
     "vitepress-plugin-tabs": "^0.5.0"
   }
 }
diff --git a/template/src/.vitepress/config.mts b/template/src/.vitepress/config.mts
@@ -39,7 +39,22 @@ export default defineConfig({
     ['script', {src: `${baseTemp.base}siteinfo.js`}]
   ],
   ignoreDeadLinks: true,
-
+  vite: {
+    optimizeDeps: {
+      exclude: [ 
+        '@nolebase/vitepress-plugin-enhanced-readabilities/client',
+        'vitepress',
+        '@nolebase/ui',
+      ], 
+    }, 
+    ssr: { 
+      noExternal: [ 
+        // If there are other packages that need to be processed by Vite, you can add them here.
+        '@nolebase/vitepress-plugin-enhanced-readabilities',
+        '@nolebase/ui',
+      ], 
+    },
+  },
   markdown: {
     math: true,
     config(md) {

diff --git a/template/src/.vitepress/theme/index.ts b/template/src/.vitepress/theme/index.ts
@@ -1,6 +1,13 @@
 // .vitepress/theme/index.ts
 import { h } from 'vue'
 import type { Theme } from 'vitepress'
+import { 
+  NolebaseEnhancedReadabilitiesMenu, 
+  NolebaseEnhancedReadabilitiesScreenMenu, 
+} from '@nolebase/vitepress-plugin-enhanced-readabilities/client'
+
+import '@nolebase/vitepress-plugin-enhanced-readabilities/client/style.css'
+
 import DefaultTheme from 'vitepress/theme'
 import VersionPicker from "../../components/VersionPicker.vue"
 import AuthorBadge from '../../components/AuthorBadge.vue'
@@ -13,7 +20,11 @@ export default {
   extends: DefaultTheme,
   Layout() {
     return h(DefaultTheme.Layout, null, {
-      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+      'nav-bar-content-after': () => [
+        h(NolebaseEnhancedReadabilitiesMenu), // Enhanced Readabilities menu
+      ],
+      // A enhanced readabilities menu for narrower screens (usually smaller than iPad Mini)
+      'nav-screen-content-after': () => h(NolebaseEnhancedReadabilitiesScreenMenu),
     })
   },
   enhanceApp({ app, router, siteData }) {