Skip to content

目录结构

Teek 的目录结构如下:

sh
packages.├─components# 组件目录,具体内容请看「组件布局的目录结构」├─config# 配置文件目录,在 `.vitepress/config.mts` 文件中引入├─helper# 工具类目录├─composables# composables 目录├─locale# 国际化文件目录├─markdown# markdown 插件目录├─static# 静态资源目录├─teek# Teek 入口文件├─theme-chalk# 样式目录,具体内容请看「样式布局的样式目录」

helper目录结构如下:

sh
helper.|├─analytics||├─baiduAnalytics.ts# 百度统计函数||├─googleAnalytics.ts# 谷歌统计函数||├─umamiAnalytics.ts# umami 统计函数├─color.ts# 颜色计算函数├─date.ts# 日期格式化函数├─index.ts# 工具函数入口文件,导出了所有的工具函数├─is.ts# 判断类型函数,如 isString、isFunction 等├─types.ts# 常用的 TS 类型├─util.ts# 基础工具函数

composables目录结构如下:

sh
composables.├─index.ts# composables 入口文件,导出了所有的 composables 函数├─onClickOutside.ts# 监听鼠标点击外部元素函数├─useAnchorScroll.ts# 锚点滚动函数├─useBuSunZi.ts# 不蒜子访问量统计函数├─useClipboard.ts# 文本复制函数├─useDebounce.ts# 防抖函数├─useElementHover.ts# 监听鼠标悬停指定元素函数├─useEventListener.ts# 使用事件监听函数├─useLocale.ts# 多语言读取函数├─useMediaQuery.ts# 媒体查询函数,常用于获取 max-width、min-width 来判断是否为移动端├─useMounted.ts# 监听元素全部挂载完成函数,使用了 Vue 的 onMounted 生命周期├─useNamespace.ts# 命名空间函数,具体使用请看「样式布局的组件元素使用 BEM」├─usePopoverSize.ts# 计算 Popover 出现的位置├─useScopeDispose.ts# 父作用域销毁函数,概念等于 Vue 的 onUnmounted 生命周期├─useScrollData.ts# 数据滚动函数,用于友情链接卡片自动向下滚动├─useStorage.ts# 管理存储的函数,根据传入的存储类型(sessionStorage 或 localStorage)返回相应的操作函数├─useSwitchData.ts# 数据定时切换函数,用于 Body、Banner 的图片切换├─useTextTypes.ts# 文本打印函数,用于 Banner 的详细描述打印效果├─useThemeColor.ts# 主题色计算函数,自动根据主题色计算其他的颜色├─useViewTransition.ts# 切换动画效果函数,用于深色、浅色模式切换├─useVpRouter.ts# 绑定自定义函数到 Router 的钩子里,为了防止覆盖掉其他人已添加在 Router 钩子的逻辑,useVpRouter 不是直接覆盖,而是追加├─useWindowSize.ts# 窗口大小监听函数,用于实时监听窗口的 width、height├─useZIndex.ts# z-index 管理函数

其他目录结构内容较少,从命名可以看出效果,因此暂不进行详细说明。

最近更新