@sugarat/theme 0.5.15 → 0.5.17

package/node.d.ts

@@ -1,4 +1,5 @@
 import { DefaultTheme, UserConfig } from 'vitepress';
+import { BackToTopPluginOptions } from 'vitepress-plugin-back2top';
 import { RSSOptions } from 'vitepress-plugin-rss';
 import { Repo, Mapping } from '@giscus/vue';
 import { Options } from 'oh-my-live2d';
@@ -106,6 +107,7 @@ declare namespace Theme {
         inputPosition?: 'top' | 'bottom';
         lang?: string;
         loading?: 'lazy' | 'eager';
+        showCommentBtn?: boolean;
     }
     interface ArtalkOption {
         site: string;
@@ -498,17 +500,7 @@ declare namespace Theme {
          */
         weeksAgo?: string;
     } | ((date: Date | string) => string);
-    interface BackToTop {
-        /**
-         * 距离顶部多少距离出现
-         * @default 450
-         */
-        top?: number;
-        /**
-         * 设置展示图标，svg
-         * @recommend https://iconbuddy.app/search?q=fire
-         */
-        icon?: string;
+    interface BackToTop extends BackToTopPluginOptions {
     }
     interface TaskCheckbox {
         disabled?: boolean;
@@ -627,6 +619,19 @@ declare namespace Theme {
          * @default 999
          */
         limit?: number;
+        /**
+         * 标签排序方式
+         * desc: 降序
+         * asc: 升序
+         * normal: 不排序 (默认)
+         * @default 'normal'
+         */
+        sort?: 'desc' | 'asc' | 'normal';
+        /**
+         * 是否显示文章数量
+         * @default false
+         */
+        showCount?: boolean;
     }
 }
 

package/node.js

@@ -463,13 +463,6 @@ async function getArticles(cfg, vpConfig) {
 }
 function patchVPConfig(vpConfig, cfg) {
   vpConfig.head = vpConfig.head || [];
-  if (cfg?.comment && "type" in cfg.comment && cfg?.comment?.type === "artalk") {
-    const server = cfg.comment?.options?.server;
-    if (server) {
-      vpConfig.head.push(["link", { href: `${server} /dist/Artalk.css`, rel: "stylesheet" }]);
-      vpConfig.head.push(["script", { src: `${server} /dist/Artalk.js`, id: "artalk-script" }]);
-    }
-  }
 }
 function patchVPThemeConfig(cfg, vpThemeConfig = {}) {
   vpThemeConfig.sidebar = patchDefaultThemeSideBar(cfg)?.sidebar;
@@ -487,6 +480,9 @@ var import_vitepress_plugin_pagefind = require("vitepress-plugin-pagefind");
 var import_vitepress_plugin_rss = require("vitepress-plugin-rss");
 var import_theme_shared4 = require("@sugarat/theme-shared");
 var import_vitepress_plugin_announcement = require("vitepress-plugin-announcement");
+var import_vitepress_plugin_artalk = require("vitepress-plugin-artalk");
+var import_vitepress_plugin_back2top = require("vitepress-plugin-back2top");
+var import_vitepress_plugin_giscus = require("vitepress-plugin-giscus");
 var import_vitepress_plugin_group_icons2 = require("vitepress-plugin-group-icons");
 var import_vitepress_plugin_image_preview = require("vitepress-plugin-image-preview");
 
@@ -595,6 +591,25 @@ function getVitePlugins(cfg = {}) {
     ;
     [cfg?.RSS].flat().forEach((rssConfig) => plugins.push((0, import_vitepress_plugin_rss.RssPlugin)(rssConfig)));
   }
+  if (cfg?.comment && typeof cfg.comment !== "boolean") {
+    const commentConfig = cfg.comment;
+    const isArtalk = commentConfig.type === "artalk";
+    if (isArtalk) {
+      plugins.push((0, import_vitepress_plugin_artalk.artalkPlugin)(commentConfig.options));
+    }
+    const isGiscus = commentConfig.type === "giscus" || commentConfig.repo;
+    if (isGiscus) {
+      const { mobileMinify, label, icon } = commentConfig;
+      const options = {
+        ...commentConfig.options,
+        ...commentConfig,
+        mobileMinify,
+        label,
+        icon
+      };
+      plugins.push((0, import_vitepress_plugin_giscus.giscusPlugin)(options));
+    }
+  }
   if (cfg?.popover) {
     plugins.push((0, import_vitepress_plugin_announcement.AnnouncementPlugin)(cfg.popover));
   }
@@ -608,6 +623,10 @@ function getVitePlugins(cfg = {}) {
   if (cfg?.timeline !== false) {
     plugins.push(patchTimelinePlugin());
   }
+  if (cfg?.backToTop !== false) {
+    const options = typeof cfg.backToTop === "object" ? cfg.backToTop : {};
+    plugins.push((0, import_vitepress_plugin_back2top.back2topPlugin)(options));
+  }
   return plugins;
 }
 function patchGroupIconPlugin() {

package/node.mjs

@@ -430,13 +430,6 @@ async function getArticles(cfg, vpConfig) {
 }
 function patchVPConfig(vpConfig, cfg) {
   vpConfig.head = vpConfig.head || [];
-  if (cfg?.comment && "type" in cfg.comment && cfg?.comment?.type === "artalk") {
-    const server = cfg.comment?.options?.server;
-    if (server) {
-      vpConfig.head.push(["link", { href: `${server} /dist/Artalk.css`, rel: "stylesheet" }]);
-      vpConfig.head.push(["script", { src: `${server} /dist/Artalk.js`, id: "artalk-script" }]);
-    }
-  }
 }
 function patchVPThemeConfig(cfg, vpThemeConfig = {}) {
   vpThemeConfig.sidebar = patchDefaultThemeSideBar(cfg)?.sidebar;
@@ -456,6 +449,9 @@ import {
 import { RssPlugin } from "vitepress-plugin-rss";
 import { cacheAllGitTimestamps, joinPath as joinPath2 } from "@sugarat/theme-shared";
 import { AnnouncementPlugin } from "vitepress-plugin-announcement";
+import { artalkPlugin } from "vitepress-plugin-artalk";
+import { back2topPlugin } from "vitepress-plugin-back2top";
+import { giscusPlugin } from "vitepress-plugin-giscus";
 import { groupIconVitePlugin } from "vitepress-plugin-group-icons";
 import { ImagePreviewPlugin } from "vitepress-plugin-image-preview";
 
@@ -564,6 +560,25 @@ function getVitePlugins(cfg = {}) {
     ;
     [cfg?.RSS].flat().forEach((rssConfig) => plugins.push(RssPlugin(rssConfig)));
   }
+  if (cfg?.comment && typeof cfg.comment !== "boolean") {
+    const commentConfig = cfg.comment;
+    const isArtalk = commentConfig.type === "artalk";
+    if (isArtalk) {
+      plugins.push(artalkPlugin(commentConfig.options));
+    }
+    const isGiscus = commentConfig.type === "giscus" || commentConfig.repo;
+    if (isGiscus) {
+      const { mobileMinify, label, icon } = commentConfig;
+      const options = {
+        ...commentConfig.options,
+        ...commentConfig,
+        mobileMinify,
+        label,
+        icon
+      };
+      plugins.push(giscusPlugin(options));
+    }
+  }
   if (cfg?.popover) {
     plugins.push(AnnouncementPlugin(cfg.popover));
   }
@@ -577,6 +592,10 @@ function getVitePlugins(cfg = {}) {
   if (cfg?.timeline !== false) {
     plugins.push(patchTimelinePlugin());
   }
+  if (cfg?.backToTop !== false) {
+    const options = typeof cfg.backToTop === "object" ? cfg.backToTop : {};
+    plugins.push(back2topPlugin(options));
+  }
   return plugins;
 }
 function patchGroupIconPlugin() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sugarat/theme",
-  "version": "0.5.15",
+  "version": "0.5.17",
   "description": "简约风的 Vitepress 博客主题，sugarat vitepress blog theme",
   "author": "sugar",
   "license": "MIT",
@@ -51,11 +51,14 @@
     "vitepress-plugin-group-icons": "1.6.5",
     "vitepress-plugin-mermaid": "2.0.13",
     "vitepress-plugin-tabs": "0.7.3",
-    "@sugarat/theme-shared": "0.0.7",
     "vitepress-plugin-announcement": "0.1.7",
+    "@sugarat/theme-shared": "0.0.7",
+    "vitepress-plugin-giscus": "0.1.0",
     "vitepress-plugin-image-preview": "0.1.1",
+    "vitepress-plugin-rss": "0.4.3",
+    "vitepress-plugin-artalk": "0.1.0",
     "vitepress-plugin-pagefind": "0.4.19",
-    "vitepress-plugin-rss": "0.4.3"
+    "vitepress-plugin-back2top": "0.1.0"
   },
   "devDependencies": {
     "artalk": "^2.8.5",

package/src/components/BlogApp.vue

@@ -13,13 +13,8 @@ import BlogArticleAnalyze from './BlogArticleAnalyze.vue'
 import BlogAlert from './BlogAlert.vue'
 import BlogFooter from './BlogFooter.vue'
 import BlogHomeHeaderAvatar from './BlogHomeHeaderAvatar.vue'
-import BlogBackToTop from './BlogBackToTop.vue'
-import CommentGiscus from './CommentGiscus.vue'
 import BlogOml2d from './BlogOml2d.vue'
-
-import CommentArtalk from './CommentArtalk.vue'
 import BlogButtonAfterArticle from './BlogButtonAfterArticle.vue'
-import BlogCommentWrapper from './BlogCommentWrapper.vue'
 
 const { frontmatter } = useData()
 const layout = computed(() => frontmatter.value.layout)
@@ -86,11 +81,6 @@ const openTransition = useDarkTransitionConfig()
       <!-- 评论 -->
       <ClientOnly>
         <BlogButtonAfterArticle />
-        <BlogBackToTop />
-        <BlogCommentWrapper>
-          <CommentArtalk />
-          <CommentGiscus />
-        </BlogCommentWrapper>
       </ClientOnly>
     </template>
     <template #layout-bottom>

package/src/components/BlogHomeTags.vue

@@ -31,13 +31,18 @@ const tagsWithCount = computed(() => {
     })
   })
   // 按文章数量降序排序
-  return [...tagCountMap.entries()]
-    .sort((a, b) => b[1] - a[1])
-    .map(([tag, count]) => ({ tag, count }))
+  const data = [...tagCountMap.entries()]
+  const sort = (typeof homeTagsConfig.value === 'object' && homeTagsConfig.value?.sort) ? homeTagsConfig.value.sort : 'normal'
+  if (sort !== 'normal') {
+    data.sort((a, b) => {
+      return sort === 'asc' ? a[1] - b[1] : b[1] - a[1]
+    })
+  }
+  return data.map(([tag, count]) => ({ tag, count }))
 })
 
 // 折叠/展开功能，从配置中读取 limit，默认 10
-const showCount = computed(() => {
+const limit = computed(() => {
   if (typeof homeTagsConfig.value === 'object' && homeTagsConfig.value?.limit) {
     return homeTagsConfig.value.limit
   }
@@ -45,12 +50,12 @@ const showCount = computed(() => {
 })
 const isExpanded = ref(false)
 const displayTags = computed(() => {
-  if (isExpanded.value || tagsWithCount.value.length <= showCount.value) {
+  if (isExpanded.value || tagsWithCount.value.length <= limit.value) {
     return tagsWithCount.value
   }
-  return tagsWithCount.value.slice(0, showCount.value)
+  return tagsWithCount.value.slice(0, limit.value)
 })
-const hasMore = computed(() => tagsWithCount.value.length > showCount.value)
+const hasMore = computed(() => tagsWithCount.value.length > limit.value)
 
 function toggleExpand() {
   isExpanded.value = !isExpanded.value
@@ -130,7 +135,7 @@ watch(
           @click="handleTagClick(item.tag, tagType[idx % tagType.length])"
         >
           {{ item.tag }}
-          <span class="tag-count">{{ item.count }}</span>
+          <span v-if="typeof homeTagsConfig === 'object' && homeTagsConfig?.showCount" class="tag-count">{{ item.count }}</span>
         </Tag>
       </li>
     </ul>

package/src/composables/config/index.ts

@@ -1,5 +1,6 @@
 /* eslint-disable ts/no-namespace */
 import type { DefaultTheme } from 'vitepress'
+import type { BackToTopPluginOptions } from 'vitepress-plugin-back2top'
 import type { RSSOptions } from 'vitepress-plugin-rss'
 import type { Mapping, Repo } from '@giscus/vue'
 import type { Options as Oml2dOptions } from 'oh-my-live2d'
@@ -109,6 +110,7 @@ export namespace Theme {
     inputPosition?: 'top' | 'bottom'
     lang?: string
     loading?: 'lazy' | 'eager'
+    showCommentBtn?: boolean
   }
   export interface ArtalkOption {
     site: string
@@ -528,18 +530,7 @@ export namespace Theme {
      */
     weeksAgo?: string
   } | ((date: Date | string) => string)
-  export interface BackToTop {
-    /**
-     * 距离顶部多少距离出现
-     * @default 450
-     */
-    top?: number
-
-    /**
-     * 设置展示图标，svg
-     * @recommend https://iconbuddy.app/search?q=fire
-     */
-    icon?: string
+  export interface BackToTop extends BackToTopPluginOptions {
   }
 
   export interface TaskCheckbox {
@@ -664,5 +655,18 @@ export namespace Theme {
      * @default 999
      */
     limit?: number
+    /**
+     * 标签排序方式
+     * desc: 降序
+     * asc: 升序
+     * normal: 不排序 (默认)
+     * @default 'normal'
+     */
+    sort?: 'desc' | 'asc' | 'normal'
+    /**
+     * 是否显示文章数量
+     * @default false
+     */
+    showCount?: boolean
   }
 }

package/src/utils/node/theme.ts

@@ -128,14 +128,14 @@ export async function getArticles(cfg: Partial<Theme.BlogConfig>, vpConfig: Site
 
 export function patchVPConfig(vpConfig: any, cfg?: Partial<Theme.BlogConfig>) {
   vpConfig.head = vpConfig.head || []
-  // Artalk 资源地址
-  if (cfg?.comment && 'type' in cfg.comment && cfg?.comment?.type === 'artalk') {
-    const server = cfg.comment?.options?.server
-    if (server) {
-      vpConfig.head.push(['link', { href: `${server} /dist/Artalk.css`, rel: 'stylesheet' }])
-      vpConfig.head.push(['script', { src: `${server} /dist/Artalk.js`, id: 'artalk-script' }])
-    }
-  }
+  // // Artalk 资源地址
+  // if (cfg?.comment && 'type' in cfg.comment && cfg?.comment?.type === 'artalk') {
+  //   const server = cfg.comment?.options?.server
+  //   if (server) {
+  //     vpConfig.head.push(['link', { href: `${server}/dist/Artalk.css`, rel: 'stylesheet' }])
+  //     vpConfig.head.push(['script', { src: `${server}/dist/Artalk.js`, id: 'artalk-script' }])
+  //   }
+  // }
 }
 
 export function patchVPThemeConfig(

package/src/utils/node/vitePlugins.ts

@@ -6,6 +6,9 @@ import { RssPlugin } from 'vitepress-plugin-rss'
 import type { PluginOption } from 'vite'
 import { cacheAllGitTimestamps, joinPath } from '@sugarat/theme-shared'
 import { AnnouncementPlugin } from 'vitepress-plugin-announcement'
+import { artalkPlugin } from 'vitepress-plugin-artalk'
+import { back2topPlugin } from 'vitepress-plugin-back2top'
+import { giscusPlugin } from 'vitepress-plugin-giscus'
 import { groupIconVitePlugin } from 'vitepress-plugin-group-icons'
 import { ImagePreviewPlugin } from 'vitepress-plugin-image-preview'
 import type { Theme } from '../../composables/config/index'
@@ -56,6 +59,27 @@ export function getVitePlugins(cfg: Partial<Theme.BlogConfig> = {}) {
     ;[cfg?.RSS].flat().forEach(rssConfig => plugins.push(RssPlugin(rssConfig)))
   }
 
+  // 内置支持 giscus 评论
+  if (cfg?.comment && typeof cfg.comment !== 'boolean') {
+    const commentConfig = cfg.comment
+    const isArtalk = (commentConfig as any).type === 'artalk'
+    if (isArtalk) {
+      plugins.push(artalkPlugin((commentConfig as any).options))
+    }
+    const isGiscus = (commentConfig as any).type === 'giscus' || (commentConfig as any).repo
+    if (isGiscus) {
+      const { mobileMinify, label, icon } = commentConfig
+      const options = {
+        ...(commentConfig as any).options,
+        ...commentConfig,
+        mobileMinify,
+        label,
+        icon
+      }
+      plugins.push(giscusPlugin(options))
+    }
+  }
+
   // 内置支持 全局公告
   if (cfg?.popover) {
     plugins.push(AnnouncementPlugin(cfg.popover))
@@ -76,6 +100,11 @@ export function getVitePlugins(cfg: Partial<Theme.BlogConfig> = {}) {
   if (cfg?.timeline !== false) {
     plugins.push(patchTimelinePlugin())
   }
+  // 内置支持 back-to-top
+  if (cfg?.backToTop !== false) {
+    const options = typeof cfg.backToTop === 'object' ? cfg.backToTop : {}
+    plugins.push(back2topPlugin(options))
+  }
   return plugins
 }