feat(index): new plugin vitepress-plugin-index (#328)

Author: nekomeowww

.vscode/settings.json

@@ -20,16 +20,6 @@
     "jsonc",
     "yaml"
   ],
-  "unocss.root": [
-    ".",
-    "./docs",
-    "./packages/vitepress-plugin-enhanced-readabilities",
-    "./packages/vitepress-plugin-git-changelog",
-    "./packages/vitepress-plugin-graph-view",
-    "./packages/vitepress-plugin-inline-link-preview",
-    "./packages/vitepress-plugin-page-properties",
-    "./packages/vitepress-plugin-thumbnail-hash"
-  ],
   "typescript.tsdk": "node_modules/typescript/lib",
   "i18n-ally.localesPaths": [
     "packages/**/src/locales"

docs/.vitepress/twoslashConfig.ts

@@ -11,24 +11,48 @@ export const compilerOptions = {
       '@nolebase/ui': [
         '../packages/ui/src/index.ts',
       ],
+      '@nolebase/ui-asciinema': [
+        '../packages/ui-asciinema/src/index.ts',
+      ],
+      '@nolebase/ui-rive-canvas': [
+        '../packages/ui-rive-canvas/src/index.ts',
+      ],
       '@nolebase/unconfig-vitepress/*': [
         '../packages/unconfig-vitepress/src/*',
       ],
+      '@nolebase/vitepress-plugin-data-driver/*': [
+        '../packages/vitepress-plugin-data-driver/src/*',
+      ],
       '@nolebase/vitepress-plugin-enhanced-readabilities/*': [
         '../packages/vitepress-plugin-enhanced-readabilities/src/*',
       ],
       '@nolebase/vitepress-plugin-highlight-targeted-heading/*': [
         '../packages/vitepress-plugin-highlight-targeted-heading/src/*',
       ],
+      '@nolebase/vitepress-plugin-index/*': [
+        '../packages/vitepress-plugin-index/src/*',
+      ],
       '@nolebase/vitepress-plugin-inline-link-preview/*': [
         '../packages/vitepress-plugin-inline-link-preview/src/*',
       ],
+      '@nolebase/vitepress-plugin-meta/*': [
+        '../packages/vitepress-plugin-meta/src/*',
+      ],
       '@nolebase/vitepress-plugin-git-changelog/*': [
         '../packages/vitepress-plugin-git-changelog/src/*',
       ],
+      '@nolebase/vitepress-plugin-graph-view/*': [
+        '../packages/vitepress-plugin-graph-view/src/*',
+      ],
+      '@nolebase/vitepress-plugin-og-image/*': [
+        '../packages/vitepress-plugin-og-image/src/*',
+      ],
       '@nolebase/vitepress-plugin-page-properties/*': [
         '../packages/vitepress-plugin-page-properties/src/*',
       ],
+      '@nolebase/vitepress-plugin-sidebar/*': [
+        '../packages/vitepress-plugin-sidebar/src/*',
+      ],
       '@nolebase/vitepress-plugin-thumbnail-hash/*': [
         '../packages/vitepress-plugin-thumbnail-hash/src/*',
       ],

docs/data/en/recentUpdates.data.ts

@@ -0,0 +1,11 @@
+import { createRecentUpdatesLoader } from '@nolebase/vitepress-plugin-index/vitepress'
+
+export default createRecentUpdatesLoader({
+  dir: 'pages/en',
+  rewrites: [
+    { from: /^pages\/en\//, to: '' },
+  ],
+  ignores: [
+    '**/snippets/**.md',
+  ],
+})

docs/data/zh-CN/recentUpdates.data.ts

@@ -0,0 +1,11 @@
+import { createRecentUpdatesLoader } from '@nolebase/vitepress-plugin-index/vitepress'
+
+export default createRecentUpdatesLoader({
+  dir: 'pages/zh-CN',
+  rewrites: [
+    { from: /^pages\/zh-CN\//, to: '' },
+  ],
+  ignores: [
+    '**/snippets/**.md',
+  ],
+})

docs/package.json

@@ -28,12 +28,14 @@
     "@nolebase/vitepress-plugin-git-changelog": "workspace:^",
     "@nolebase/vitepress-plugin-graph-view": "workspace:^",
     "@nolebase/vitepress-plugin-highlight-targeted-heading": "workspace:^",
+    "@nolebase/vitepress-plugin-index": "workspace:^",
     "@nolebase/vitepress-plugin-inline-link-preview": "workspace:^",
     "@nolebase/vitepress-plugin-meta": "workspace:^",
     "@nolebase/vitepress-plugin-og-image": "workspace:^",
     "@nolebase/vitepress-plugin-page-properties": "workspace:^",
+    "@nolebase/vitepress-plugin-sidebar": "workspace:^",
     "@nolebase/vitepress-plugin-thumbnail-hash": "workspace:^",
-    "@rive-app/canvas": "^2.22.0",
+    "@rive-app/canvas": "^2.23.4",
     "@rollup/plugin-yaml": "^4.1.2",
     "@shikijs/vitepress-twoslash": "^1.22.2",
     "@types/markdown-it": "^14.1.2",
@@ -45,7 +47,8 @@
     "markdown-it-footnote": "^4.0.0",
     "motion": "^10.18.0",
     "thumbhash": "^0.1.1",
-    "unlazy": "^0.11.3",
-    "vite-plugin-vue-devtools": "^7.6.1"
+    "typescript": "^5.6.3",
+    "unlazy": "^0.11.4",
+    "vite-plugin-vue-devtools": "^7.6.3"
   }
 }

docs/pages/en/guide/getting-started.md

@@ -1,3 +1,8 @@
+---
+title: Getting Started
+category: Index
+---
+
 # Getting Started
 
 ::: warning 🚧 Constructing

docs/pages/en/index.md

@@ -32,6 +32,9 @@ features:
   - icon: <span class="rive-canvas" data-rive-canvas="true" data-rive-src="/icons/rocket-emoji-animated.riv"></span>
     title: Writing First
     details: From the perspective of documentation engineering, solve and simplify some UX/DX problems, aiming to let creators focus on writing documents, notes, making cards and GTD!
+
+nolebase:
+  index: false
 ---
 
 <script setup>

docs/pages/en/integrations/index.md

@@ -1,3 +1,8 @@
+---
+title: Integrations
+category: Index
+---
+
 <script setup>
 import sidebarPackageJSON from '~/packages/vitepress-plugin-sidebar/package.json'
 import biDirectionalLinksPackageJSON from '~/packages/markdown-it-bi-directional-links/package.json'

docs/pages/en/integrations/markdown-it-bi-directional-links/Bi-directional Links Example Page.md

@@ -1,3 +1,8 @@
+---
+title: Bi-directional Links
+category: Bi-directional Links
+---
+
 # Bi-directional Links Example Page
 
 Hi! This is a linked internal page.

docs/pages/en/integrations/markdown-it-bi-directional-links/Bi-directional Links Example Same Name Page.md

@@ -1,3 +1,8 @@
+---
+title: Bi-directional Links
+category: Bi-directional Links
+---
+
 # Bi-directional Links Example Same Name Page
 
 Hi! This is a linked internal page.