卡片栏配置

homeCardSort

• 类型：("topArticle"|"category"|"tag"|"friendLink"|"docAnalysis")[]
• 默认值：["topArticle","category","tag","friendLink","docAnalysis"]

首页卡片的位置排序，当设置了 homeCardSort但没有全部补全内容，Teek 会将剩余内容按照 homeCardSort的顺序进行添加。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({homeCardSort:["topArticle","category","tag","friendLink","docAnalysis"],});

index.md

---tk:homeCardSort:- topArticle- category- tag- friendLink- docAnalysis---

tagColor v1.1.5

• 类型：string[]
• 默认值：

[{"border":"#bfdbfe","bg":"#eff6ff","text":"#2563eb"},{"border":"#e9d5ff","bg":"#faf5ff","text":"#9333ea"},{"border":"#fbcfe8","bg":"#fdf2f8","text":"#db2777"},{"border":"#a7f3d0","bg":"#ecfdf5","text":"#059669"},{"border":"#fde68a","bg":"#fffbeb","text":"#d97706"},{"border":"#a5f3fc","bg":"#ecfeff","text":"#0891b2"},{"border":"#c7d2fe","bg":"#eef2ff","text":"#4f46e5"}]

标签背景色，用于精选文章卡片的 top + sticky功能和标签卡片的标签，背景色按顺序显示。

当在文章页的 frontmatter配置时，如果颜色值有 #号时请添加引号。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({bgColor:["#e74c3c","#409EFF","#DAA96E","#0C819F","#27ae60","#ff5c93","#fd726d","#f39c12","#9b59b6"],});

index.md

---tk:bgColor:- "#e74c3c"- "#409EFF"- "#DAA96E"- "#0C819F"- "#27ae60"- "#ff5c93"- "#fd726d"- "#f39c12"- "#9b59b6"---

blogger

博主信息，显示在首页左边第一个卡片。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({blogger:{name:"天客",avatar:"https:slogan:"朝圣的使徒，正在走向编程的至高殿堂！",shape:"square",},});

index.md

---tk:blogger:name:天客avatar:https:slogan:朝圣的使徒，正在走向编程的至高殿堂！shape:square---

更多配置项

interfaceBlogger{name:string;avatar:string;slogan?:string;shape?:TkAvatarProps["shape"] |"circle-rotate";circleBgImg?:string;}

topArticle

精选文章卡片配置。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({topArticle:{enabled:true,limit:5,autoPage:false,pageSpeed:4000,dateFormat:"yyyy-MM-dd hh:mm:ss",},});

index.md

---tk:topArticle:enabled:truelimit:5autoPage:falsepageSpeed:4000---

更多配置项

importtype{VpRouter } from"@teek/composables";interfaceTopArticle{enabled?:boolean;title?:string|((icon:string) =>string);emptyLabel?:string;limit?:number;autoPage?:boolean;pageSpeed?:number;dateFormat?:"yyyy-MM-dd"|"yyyy-MM-dd hh:mm:ss"|((date:number|string) =>string);titleClick?:(router:VpRouter) =>void;}

category

分类卡片配置。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({category:{enabled:true,limit:5,autoPage:false,pageSpeed:4000,},});

index.md

---tk:category:enabled:truelimit:5autoPage:falsepageSpeed:4000---

更多配置项

interfaceCategory{enabled?:boolean;path?:string;pageTitle?:string|((icon:string) =>string);homeTitle?:string|((icon:string) =>string);moreLabel?:string;emptyLabel?:string;limit?:number;autoPage?:boolean;pageSpeed?:number;}

tag

标签卡片配置。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({tag:{enabled:true,limit:21,autoPage:false,pageSpeed:4000,},});

index.md

---tk:tag:enabled:truelimit:5autoPage:falsepageSpeed:4000---

更多配置项

interfaceTag{enabled?:boolean;path?:string;pageTitle?:string|((icon:string) =>string);homeTitle?:string|((icon:string) =>string);moreLabel?:string;emptyLabel?:string;limit?:number;autoPage?:boolean;pageSpeed?:number;}

friendLink

友情链接卡片配置。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({friendLink:{enabled:true,list:[{name:"Teeker",desc:"朝圣的使徒，正在走向编程的至高殿堂！",avatar:"https:link:"http:},{name:"vuepress-theme-vdoing",desc:"🚀一款简洁高效的VuePress 知识管理&博客 主题",avatar:"https:link:"http:},{name:"vuepress-theme-vdoing",desc:"🚀一款简洁高效的VuePress 知识管理&博客 主题",avatar:"https:link:"https:},{name:"One",desc:"明心静性，爱自己",avatar:"https:link:"https:},{name:"Hyde Blog",desc:"人心中的成见是一座大山",avatar:"https:link:"https:},{name:"二丫讲梵",desc:"💻学习📝记录🔗分享",avatar:"https:link:"https:},],limit:5,autoScroll:false,scrollSpeed:2500,autoPage:false,pageSpeed:4000,},});

index.md

---tk:friendLink:enabled:truelist:- name:测试1desc:这是一个友链测试1avatar:/img/bg1.jpglink:https:- name:测试2desc:这是一个友链测试2222111啊avatar:/img/ui.pnglimit:5autoScroll:falsescrollSpeed:2500autoPage:falsepageSpeed:4000---

更多配置项

importtype{VpRouter } from"vitepress-theme-teek";interfaceFriendLink{enabled?:boolean;list?:{name:string;avatar?:string;desc?:string;link?:string;alt?:string;}[];title?:string|((icon:string) =>string);emptyLabel?:string;limit?:number;autoScroll?:boolean;scrollSpeed?:number;autoPage?:boolean;pageSpeed?:number;titleClick?:(router:VpRouter) =>void;}

docAnalysis

站点信息卡片配置。

config.mts

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({docAnalysis:{enabled:true,createTime:"2021-10-19",wordCount:true,readingTime:true,statistics:{provider:"busuanzi",siteView:true,pageView:true,},overrideInfo:[{key:"lastActiveTime",label:"活跃时间",value:(_,currentValue) =>(currentValue +"").replace("前",""),show:true,},],appendInfo:[{key:"index",label:"序号",value:"天客 99"}],},});

index.md

---tk:docAnalysis:enabled:truecreateTime:2021-10-19wordCount:truereadingTime:truestatistics:provider:"busuanzi"siteView:truepageView:trueappendInfo:- key:"index"label:"序号"value:"天客 99"---

更多配置项

interfaceDocAnalysis{enabled?:boolean;title?:string|((icon:string) =>string);createTime?:string;wordCount?:boolean;readingTime?:boolean;statistics?:{provider?:""|"busuanzi";siteView?:boolean;pageView?:boolean;tryRequest?:boolean;tryCount?:number;tryIterationTime?:number;permalink?:boolean;};overrideInfo?:(Omit<PartialKey<DocAnalysisInfo,"label">,"value">&{value?:(originValue:string|number,currentValue?:string|number) =>string;})[];appendInfo?:(Omit<DocAnalysisInfo,"key">&{key:string})[];}interfaceDocAnalysisInfo{key:|"totalPosts"|"weekAddNum"|"monthAddNum"|"runtime"|"totalWordCount"|"lastActiveTime"|"viewCount"|"visitCount"|string;label:string;value:string;show?:boolean;}

提示

如果想开启访问量、访客数统计，请使用 statistics配置项，目前支持 busuanzi统计方式。

当想修改站点信息内置的信息时，可以使用 overrideInfo配置项，该配置项是一个数组对象，对象的 key为信息标识，value是一个函数，接收两个参数 originValue和 currentValue：

• originValue：站点信息卡片的原始值，如创建时间为 2021-10-19
• currentValue：站点信息卡片当前渲染的值，如创建时间渲染的值为 N 天前

比如想将 文章数目改为 文章总数目：

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({docAnalysis:{overrideInfo:[{key:"totalPosts",label:"文章总数目"}],},});

比如想隐藏最后活动时间：

import{defineTeekConfig } from"vitepress-theme-teek/config";constteekConfig=defineTeekConfig({docAnalysis:{overrideInfo:[{key:"lastActiveTime",show:false}],},});

key 可选值如下：

• totalPosts：文章总数
• weekAddNum：近一周新增
• monthAddNum：近一月新增
• runtime：已运行时间
• totalWordCount：本站总字数
• lastActiveTime：最后活动时间
• viewCount：本站被访问了
• visitCount：本站曾来访过