@sugarat/theme 0.1.33 → 0.1.35

package/README.md

@@ -5,11 +5,21 @@
 ![图片](https://img.cdn.sugarat.top/mdImg/MTY3MzE3MDUxOTMwMw==673170519303)
 
 ## Quick Start
-① 初始化项目模板
-```sh
-npx degit ATQQ/sugar-blog/packages/template my-blog-demo
+① 创建项目
+
+```bash
+# With PNPM:
+pnpm create @sugarat/theme
+
+# With NPM:
+npm create @sugarat/theme@latest
+
+# With Yarn:
+yarn create @sugarat/theme
 ```
 
+![](https://img.cdn.sugarat.top/mdImg/MTY4OTQyMDE1NTcxMA==689420155710)
+
 ② 安装依赖
 ```sh
 pnpm install
@@ -24,13 +34,14 @@ pnpm dev
 ```sh
 pnpm build
 ```
+
+⑤ 预览构建产物
+```sh
+pnpm serve
+```
 ## Advanced Ssage
 详细配置见文档 https://theme.sugarat.top
 
-## Known bugs and workarounds
-* `zlib: unexpected end of file:` clearing the cache folder (rm -rf ~/.degit)
-
-
 ## Thanks
 从以下项目中获得了灵感&经验
 * [vuepress-reco/vuepress-theme-reco-1.x](https://github.com/vuepress-reco/vuepress-theme-reco-1.x)

package/node.d.ts

@@ -41,6 +41,7 @@ declare namespace Theme {
         date: string;
         tag?: string[];
         description?: string;
+        descriptionHTML?: string;
         cover?: string;
         hiddenCover?: boolean;
         readingTime?: boolean;
@@ -239,6 +240,7 @@ declare namespace Theme {
         works?: UserWorks;
         /**
          * https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
+         * @default false
          */
         mermaid?: any;
     }

package/node.js

@@ -281,7 +281,7 @@ function getThemeConfig(cfg) {
     ]);
     const wordCount = 100;
     meta.description = meta.description || getTextSummary(fileContent, wordCount);
-    meta.cover = meta.cover || fileContent.match(/[!]\[.*?\]\((https:\/\/.+)\)/)?.[1] || "";
+    meta.cover = meta.cover ?? (fileContent.match(/[!]\[.*?\]\((https:\/\/.+)\)/)?.[1] || "");
     if (meta.publish === false) {
       meta.hidden = true;
       meta.recommend = false;
@@ -353,6 +353,9 @@ function getThemeConfig(cfg) {
       }
     };
   }
+  if (cfg) {
+    cfg.mermaid = cfg?.mermaid ?? false;
+  }
   if (cfg?.mermaid !== false) {
     extraConfig.vite = {
       ...extraConfig.vite,
@@ -447,7 +450,10 @@ function defineConfig(config) {
     }, 1200);
   }
   const extendThemeConfig = config.extends?.themeConfig?.blog;
-  const resultConfig = extendThemeConfig.mermaid === false ? config : (0, import_vitepress_plugin_mermaid.withMermaid)({ ...config, mermaid: extendThemeConfig.mermaid });
+  const resultConfig = extendThemeConfig.mermaid === false ? config : (0, import_vitepress_plugin_mermaid.withMermaid)({
+    ...config,
+    mermaid: extendThemeConfig.mermaid === true ? {} : extendThemeConfig.mermaid
+  });
   if (!resultConfig.markdown)
     resultConfig.markdown = {};
   if (config.extends?.markdown?.config) {

package/package.json

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

package/src/components/BlogItem.vue

@@ -9,7 +9,12 @@
         <!-- 标题 -->
         <p class="title" v-if="!inMobile">{{ title }}</p>
         <!-- 简短描述 -->
-        <p class="description" v-if="!!description">{{ description }}</p>
+        <p class="description" v-if="!descriptionHTML && !!description">
+          {{ description }}
+        </p>
+        <template v-if="descriptionHTML">
+          <div class="description-html" v-html="descriptionHTML"></div>
+        </template>
         <!-- 底部补充描述 -->
         <div class="badge-list" v-if="!inMobile">
           <span class="split" v-if="author">{{ author }}</span>
@@ -47,15 +52,29 @@ const props = defineProps<{
   date: string | Date
   sticky?: number
   description?: string
+  descriptionHTML?: string
   tag?: string[]
   author?: string
-  cover?: string
+  cover?: string | boolean
   pin?: number
 }>()
 
 const showTime = computed(() => {
   return formatShowDate(props.date)
 })
+
+// function isWrappedWithPreventDefault(element: HTMLElement) {
+//   let parent = element.parentElement
+
+//   while (parent) {
+//     if (parent.hasAttribute('preventDefault')) {
+//       return true
+//     }
+//     parent = parent.parentElement
+//   }
+
+//   return false
+// }
 </script>
 
 <style lang="scss" scoped>
@@ -131,6 +150,9 @@ const showTime = computed(() => {
   -webkit-line-clamp: 2;
   -webkit-box-orient: vertical;
 }
+.description-html {
+  font-size: 14px;
+}
 .badge-list {
   font-size: 13px;
   color: var(--badge-font-color);

package/src/components/BlogList.vue

@@ -5,6 +5,7 @@
         :route="v.route"
         :title="v.meta.title"
         :description="v.meta.description"
+        :description-h-t-m-l="v.meta.descriptionHTML"
         :date="v.meta.date"
         :tag="v.meta.tag"
         :cover="v.meta.cover"

package/src/composables/config/index.ts

@@ -42,6 +42,7 @@ export namespace Theme {
     date: string
     tag?: string[]
     description?: string
+    descriptionHTML?: string
     cover?: string
     hiddenCover?: boolean
     readingTime?: boolean
@@ -259,6 +260,7 @@ export namespace Theme {
     works?: UserWorks
     /**
      * https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
+     * @default false
      */
     mermaid?: any
   }

package/src/node.ts

@@ -84,9 +84,8 @@ export function getThemeConfig(cfg?: Partial<Theme.BlogConfig>) {
 
       // 获取封面图
       meta.cover =
-        meta.cover ||
-        fileContent.match(/[!]\[.*?\]\((https:\/\/.+)\)/)?.[1] ||
-        ''
+        meta.cover ??
+        (fileContent.match(/[!]\[.*?\]\((https:\/\/.+)\)/)?.[1] || '')
 
       // 是否发布 默认发布
       if (meta.publish === false) {
@@ -178,6 +177,10 @@ export function getThemeConfig(cfg?: Partial<Theme.BlogConfig>) {
       }
     }
   }
+  if (cfg) {
+    cfg.mermaid = cfg?.mermaid ?? false
+  }
+
   // 流程图支持
   if (cfg?.mermaid !== false) {
     extraConfig.vite = {
@@ -329,7 +332,11 @@ export function defineConfig(config: UserConfig<Theme.Config>) {
   const resultConfig =
     extendThemeConfig.mermaid === false
       ? config
-      : withMermaid({ ...config, mermaid: extendThemeConfig.mermaid })
+      : withMermaid({
+          ...config,
+          mermaid:
+            extendThemeConfig.mermaid === true ? {} : extendThemeConfig.mermaid
+        })
 
   // 处理markdown插件
   if (!resultConfig.markdown) resultConfig.markdown = {}