Skip to content

目录结构

Teek 的 src 目录结构如下:

sh
src.
├─ assets       # 静态资源目录
├─ components   # 组件目录,具体内容请看「组件布局的目录结构」
├─ config       # 配置文件目录,在 `.vitepress/config.ts` 文件中引入
├─ helper       # 工具类目录
├─ hooks        # hooks 目录
├─ layout       # 布局组件目录
├─ markdown     # markdown 插件目录
├─ post         # 文章数据生成目录,在 Node 服务端使用
├─ styles       # 样式目录,具体内容请看「样式布局的样式目录」
└─ types        # TS 类型定义目录

helper 目录结构如下:

sh
helper.
├─ index.ts              # 工具函数入口文件,导出了所有的工具函数
├─ date.ts               # 日期格式化函数
├─ is.ts                 # 判断类型函数,如 isString、isFunction 等
├─ scrollTo.ts           # 滚动到指定页面位置函数
├─ util.ts               # 基础工具函数

hooks 目录结构如下:

sh
hooks.
├─ index.ts              # hooks 入口文件,导出了所有的 hooks 函数
├─ useAnchorScroll.ts    # 锚点滚动函数
├─ useBuSunZi.ts         # 不蒜子访问量统计函数
├─ useDebounce.ts        # 防抖函数
├─ useNamespace.ts       # 命名空间函数,具体使用请看「样式布局的组件元素使用 BEM」
├─ useScrollData.ts      # 数据滚动函数,用于友情链接卡片自动向下滚动
├─ useSwitchData.ts      # 数据定时切换函数,用于 Body、Banner 的图片切换
├─ useTextTypes.ts       # 文本打印函数,用于 Banner 的详细描述打印效果
├─ useViewTransition.ts  # 切换动画效果函数,用于深色、浅色模式切换
├─ useWindowSize.ts      # 窗口大小监听函数,用于实时监听窗口的 width、height

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