@sugarat/theme 0.1.12 → 0.1.14

package/node.d.ts

@@ -155,34 +155,14 @@ declare namespace Theme {
         friend?: FriendLink[];
     }
     interface Config extends DefaultTheme.Config {
-        blog: BlogConfig;
+        blog?: BlogConfig;
     }
     interface HomeConfig {
         handleChangeSlogan?: (oldSlogan: string) => string | Promise<string>;
     }
 }
 
-declare function getThemeConfig(cfg?: Partial<Theme.BlogConfig>): {
-    blog: {
-        blog?: false | undefined;
-        pagesData: Theme.PageData[];
-        srcDir?: string | undefined;
-        author?: string | undefined;
-        hotArticle?: Theme.HotArticle | undefined;
-        home?: Theme.HomeBlog | undefined;
-        search?: boolean | "pagefind" | undefined;
-        comment?: false | Theme.GiscusConfig | undefined;
-        recommend?: Theme.RecommendArticle | undefined;
-        article?: Theme.ArticleConfig | undefined;
-        alert?: Theme.Alert | undefined;
-        popover?: Theme.Popover | undefined;
-        friend?: Theme.FriendLink[] | undefined;
-    };
-    sidebar: {
-        text: string;
-        items: never[];
-    }[];
-};
+declare function getThemeConfig(cfg?: Partial<Theme.BlogConfig>): any;
 declare function getDefaultTitle(content: string): string;
 declare function clearMatterContent(content: string): string;
 declare function getFileBirthTime(url: string): string;

package/node.js

@@ -71,6 +71,7 @@ function formatDate(d, fmt = "yyyy-MM-dd hh:mm:ss") {
 }
 
 // src/node.ts
+var checkKeys = ["themeConfig"];
 function getThemeConfig(cfg) {
   const srcDir = cfg?.srcDir || process.argv.slice(2)?.[1] || ".";
   const files = import_fast_glob.default.sync(`${srcDir}/**/*.md`, { ignore: ["node_modules"] });
@@ -116,17 +117,76 @@ function getThemeConfig(cfg) {
       meta
     };
   }).filter((v) => v.meta.layout !== "home");
+  const extraConfig = {};
+  if (cfg?.search === "pagefind") {
+    checkKeys.push("head", "vite");
+    extraConfig.head = [
+      [
+        "script",
+        {},
+        `import('/_pagefind/pagefind.js')
+        .then((module) => {
+          window.__pagefind__ = module
+        })
+        .catch(() => {
+          console.log('not load /_pagefind/pagefind.js')
+        })`
+      ]
+    ];
+    let flag = true;
+    let originLog = null;
+    extraConfig.vite = {
+      plugins: [
+        {
+          name: "@sugarar/theme-plugin-pagefind",
+          buildEnd() {
+            const { log } = console;
+            if (flag) {
+              flag = false;
+              originLog = log;
+              Object.defineProperty(console, "log", {
+                value() {
+                  if (`${arguments[0]}`.includes("build complete")) {
+                    console.log = originLog;
+                    setTimeout(() => {
+                      originLog();
+                      originLog("=== pagefind: https://pagefind.app/ ===");
+                      const command = `npx pagefind --source ${import_path.default.join(
+                        process.argv.slice(2)?.[1] || ".",
+                        ".vitepress/dist"
+                      )}`;
+                      originLog(command);
+                      originLog();
+                      (0, import_child_process.execSync)(command, {
+                        stdio: "inherit"
+                      });
+                    }, 100);
+                  }
+                  return log.apply(this, arguments);
+                }
+              });
+            }
+          }
+        }
+      ]
+    };
+  }
   return {
-    blog: {
-      pagesData: data,
-      ...cfg
+    themeConfig: {
+      blog: {
+        pagesData: data,
+        ...cfg
+      },
+      ...cfg?.blog !== false ? {
+        sidebar: [
+          {
+            text: "",
+            items: []
+          }
+        ]
+      } : void 0
     },
-    sidebar: [
-      {
-        text: "",
-        items: []
-      }
-    ]
+    ...extraConfig
   };
 }
 function getDefaultTitle(content) {
@@ -183,59 +243,16 @@ function getTextSummary(text, count = 100) {
   return clearMatterContent(text).match(/^# ([\s\S]+)/m)?.[1]?.replace(/#/g, "")?.replace(/!\[.*?\]\(.*?\)/g, "")?.replace(/\[(.*?)\]\(.*?\)/g, "$1")?.replace(/\*\*(.*?)\*\*/g, "$1")?.split("\n")?.filter((v) => !!v)?.slice(1)?.join("\n")?.replace(/>(.*)/, "")?.slice(0, count);
 }
 function defineConfig(config) {
-  if (config?.themeConfig?.blog?.search === "pagefind") {
-    config.head = (config.head || []).concat([
-      [
-        "script",
-        {},
-        `import('/_pagefind/pagefind.js')
-      .then((module) => {
-        window.__pagefind__ = module
-      })
-      .catch(() => {
-        console.log('not load /_pagefind/pagefind.js')
-      })`
-      ]
-    ]);
-    let flag = true;
-    let originLog = null;
-    config.vite = {
-      ...config.vite,
-      plugins: [
-        ...config.vite?.plugins || [],
-        {
-          name: "@sugarar/theme-plugin-pagefind",
-          buildEnd() {
-            const { log } = console;
-            if (flag) {
-              flag = false;
-              originLog = log;
-              Object.defineProperty(console, "log", {
-                value() {
-                  if (`${arguments[0]}`.includes("build complete")) {
-                    console.log = originLog;
-                    setTimeout(() => {
-                      originLog();
-                      originLog("=== pagefind: https://pagefind.app/ ===");
-                      const command = `npx pagefind --source ${import_path.default.join(
-                        process.argv.slice(2)?.[1] || ".",
-                        ".vitepress/dist"
-                      )}`;
-                      originLog(command);
-                      originLog();
-                      (0, import_child_process.execSync)(command, {
-                        stdio: "inherit"
-                      });
-                    }, 100);
-                  }
-                  return log.apply(this, arguments);
-                }
-              });
-            }
-          }
-        }
-      ]
-    };
+  if (config.themeConfig?.themeConfig) {
+    config.extends = checkKeys.reduce((pre, key) => {
+      pre[key] = config.themeConfig[key];
+      delete config.themeConfig[key];
+      return pre;
+    }, {});
+    setTimeout(() => {
+      console.warn("==\u2193 \u4E3B\u9898\u914D\u7F6E\u65B9\u5F0F\u8FC7\u671F\uFF0C\u8BF7\u5C3D\u5FEB\u53C2\u7167\u6587\u6863\u66F4\u65B0 \u2193==");
+      console.warn("https://theme.sugarat.top/config/global.html");
+    }, 1200);
   }
   return config;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sugarat/theme",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "简约风的 Vitepress 博客主题，sugarat vitepress blog theme",
   "main": "src/index.ts",
   "exports": {

package/src/components/BlogHotArticle.vue

@@ -24,7 +24,7 @@
         <!-- 简介 -->
         <div class="des">
           <!-- title -->
-          <el-link type="info" class="title" :href="v.route">{{
+          <el-link type="info" class="title" :href="withBase(v.route)">{{
             v.meta.title
           }}</el-link>
           <!-- 描述信息 -->
@@ -42,6 +42,7 @@
 <script lang="ts" setup>
 import { ref, computed } from 'vue'
 import { ElButton, ElLink } from 'element-plus'
+import { withBase } from 'vitepress'
 import { useArticles, useBlogConfig } from '../composables/config/blog'
 import { formatShowDate } from '../utils/index'
 

package/src/components/BlogItem.vue

@@ -1,5 +1,5 @@
 <template>
-  <a class="blog-item" :href="route">
+  <a class="blog-item" :href="withBase(route)">
     <i class="pin" v-if="!!pin"></i>
     <!-- 左侧信息  -->
     <div class="info-part">
@@ -22,6 +22,7 @@
 </template>
 
 <script lang="ts" setup>
+import { withBase } from 'vitepress'
 import { computed } from 'vue'
 import { formatShowDate } from '../utils/index'
 

package/src/components/BlogRecommendArticle.vue

@@ -42,7 +42,7 @@
 <script lang="ts" setup>
 import { ref, computed } from 'vue'
 import { ElButton, ElLink } from 'element-plus'
-import { useRoute } from 'vitepress'
+import { useRoute, withBase } from 'vitepress'
 import { formatShowDate } from '../utils/index'
 import { useArticles, useBlogConfig } from '../composables/config/blog'
 
@@ -59,6 +59,7 @@ const route = useRoute()
 const recommendList = computed(() => {
   const paths = route.path.split('/')
   const origin = docs.value
+    .map((v) => ({ ...v, route: withBase(v.route) }))
     // 过滤出公共路由前缀
     // 限制为同路由前缀
     .filter(

package/src/components/BlogSearch.vue

@@ -33,7 +33,7 @@
             >
               <Command.Item
                 v-for="item in showSearchResult"
-                :data-value="item.route"
+                :data-value="withBase(item.route)"
                 :key="item.route"
                 @select="handleSelect"
               >
@@ -131,7 +131,7 @@
 import { computed, nextTick, ref, watch } from 'vue'
 // @ts-ignore
 import { Command } from 'vue-command-palette'
-import { useRoute, useRouter } from 'vitepress'
+import { useRoute, useRouter, withBase } from 'vitepress'
 import { useMagicKeys } from '@vueuse/core'
 import { formatDate } from '../utils'
 import { useArticles, useBlogConfig } from '../composables/config/blog'

package/src/composables/config/blog.ts

@@ -55,7 +55,7 @@ export function useBlogConfig() {
 }
 
 export function useBlogThemeMode() {
-  return inject(configSymbol)!.value.blog.blog ?? true
+  return inject(configSymbol)!.value?.blog?.blog ?? true
 }
 export function useHomeConfig() {
   return inject(homeConfigSymbol)!
@@ -63,7 +63,7 @@ export function useHomeConfig() {
 
 export function useGiscusConfig() {
   const blogConfig = useConfig()
-  return blogConfig.config.blog.comment
+  return blogConfig.config?.blog?.comment
 }
 
 export function useArticles() {
@@ -80,9 +80,9 @@ export function useCurrentArticle() {
   const blogConfig = useConfig()
   const route = useRoute()
 
-  const docs = computed(() => blogConfig.config.blog.pagesData)
+  const docs = computed(() => blogConfig.config?.blog?.pagesData)
   const currentArticle = computed(() =>
-    docs.value.find((v) => v.route === route.path.replace(/.html$/, ''))
+    docs.value?.find((v) => v.route === route.path.replace(/.html$/, ''))
   )
 
   return currentArticle

package/src/composables/config/index.ts

@@ -169,7 +169,7 @@ export namespace Theme {
   }
 
   export interface Config extends DefaultTheme.Config {
-    blog: BlogConfig
+    blog?: BlogConfig
   }
   export interface HomeConfig {
     handleChangeSlogan?: (oldSlogan: string) => string | Promise<string>

package/src/node.ts

@@ -8,6 +8,8 @@ import type { UserConfig } from 'vitepress'
 import { formatDate } from './utils/index'
 import type { Theme } from './composables/config/index'
 
+const checkKeys = ['themeConfig']
+
 export function getThemeConfig(cfg?: Partial<Theme.BlogConfig>) {
   const srcDir = cfg?.srcDir || process.argv.slice(2)?.[1] || '.'
   const files = glob.sync(`${srcDir}/**/*.md`, { ignore: ['node_modules'] })
@@ -82,17 +84,81 @@ export function getThemeConfig(cfg?: Partial<Theme.BlogConfig>) {
     })
     .filter((v) => v.meta.layout !== 'home')
 
+  const extraConfig: any = {}
+
+  if (cfg?.search === 'pagefind') {
+    checkKeys.push('head', 'vite')
+    extraConfig.head = [
+      [
+        'script',
+        {},
+        `import('/_pagefind/pagefind.js')
+        .then((module) => {
+          window.__pagefind__ = module
+        })
+        .catch(() => {
+          console.log('not load /_pagefind/pagefind.js')
+        })`
+      ]
+    ]
+    let flag = true
+    let originLog: any = null
+    extraConfig.vite = {
+      plugins: [
+        {
+          name: '@sugarar/theme-plugin-pagefind',
+          buildEnd() {
+            const { log } = console
+            // TODO: hack
+            if (flag) {
+              flag = false
+              originLog = log
+              Object.defineProperty(console, 'log', {
+                value() {
+                  if (`${arguments[0]}`.includes('build complete')) {
+                    console.log = originLog
+                    setTimeout(() => {
+                      originLog()
+                      originLog('=== pagefind: https://pagefind.app/ ===')
+                      const command = `npx pagefind --source ${path.join(
+                        process.argv.slice(2)?.[1] || '.',
+                        '.vitepress/dist'
+                      )}`
+                      originLog(command)
+                      originLog()
+                      execSync(command, {
+                        stdio: 'inherit'
+                      })
+                    }, 100)
+                  }
+                  // @ts-ignore
+                  return log.apply(this, arguments)
+                }
+              })
+            }
+          }
+        }
+      ]
+    }
+  }
   return {
-    blog: {
-      pagesData: data as Theme.PageData[],
-      ...cfg
+    themeConfig: {
+      blog: {
+        pagesData: data as Theme.PageData[],
+        ...cfg
+      },
+      ...(cfg?.blog !== false
+        ? {
+            sidebar: [
+              {
+                text: '',
+                items: []
+              }
+            ]
+          }
+        : undefined)
     },
-    sidebar: [
-      {
-        text: '',
-        items: []
-      }
-    ]
+    ...extraConfig
   }
 }
 
@@ -189,61 +255,22 @@ function getTextSummary(text: string, count = 100) {
 }
 
 export function defineConfig(config: UserConfig<Theme.Config>) {
-  if (config?.themeConfig?.blog?.search === 'pagefind') {
-    config.head = (config.head || []).concat([
-      [
-        'script',
-        {},
-        `import('/_pagefind/pagefind.js')
-      .then((module) => {
-        window.__pagefind__ = module
-      })
-      .catch(() => {
-        console.log('not load /_pagefind/pagefind.js')
-      })`
-      ]
-    ])
-    let flag = true
-    let originLog: any = null
-    config.vite = {
-      ...config.vite,
-      plugins: [
-        ...(config.vite?.plugins || []),
-        {
-          name: '@sugarar/theme-plugin-pagefind',
-          buildEnd() {
-            const { log } = console
-            // TODO: hack
-            if (flag) {
-              flag = false
-              originLog = log
-              Object.defineProperty(console, 'log', {
-                value() {
-                  if (`${arguments[0]}`.includes('build complete')) {
-                    console.log = originLog
-                    setTimeout(() => {
-                      originLog()
-                      originLog('=== pagefind: https://pagefind.app/ ===')
-                      const command = `npx pagefind --source ${path.join(
-                        process.argv.slice(2)?.[1] || '.',
-                        '.vitepress/dist'
-                      )}`
-                      originLog(command)
-                      originLog()
-                      execSync(command, {
-                        stdio: 'inherit'
-                      })
-                    }, 100)
-                  }
-                  // @ts-ignore
-                  return log.apply(this, arguments)
-                }
-              })
-            }
-          }
-        }
-      ]
-    }
+  // 兼容低版本主题配置
+  // @ts-ignore
+  if (config.themeConfig?.themeConfig) {
+    config.extends = checkKeys.reduce((pre, key) => {
+      // @ts-ignore
+      pre[key] = config.themeConfig[key]
+      // @ts-ignore
+      delete config.themeConfig[key]
+      return pre
+    }, {})
+
+    // 打印warn信息
+    setTimeout(() => {
+      console.warn('==↓ 主题配置方式过期，请尽快参照文档更新 ↓==')
+      console.warn('https://theme.sugarat.top/config/global.html')
+    }, 1200)
   }
   return config
 }