开发指南

开发环境

类型	名称	版本
操作系统	Windows 11 专业版	26100.3476
开发工具	Microsoft VS Code	1.96.2
调试工具	Microsoft Edge	134.0.3124.85
代码版本控制	Git	2.47.0.windows.2
语言环境	Node	22.12.0
包管理器	npm	10.9.0
包管理器	pnpm	9.15.4
node 版本管理	nvm	1.1.12
npm 源管理	nrm	1.2.6

项目结构

请看 目录结构。

克隆仓库

git clone https://github.com/Kele-Bingtang/vitepress-theme-teek.git

如果 GitHub 克隆速度较慢，你也可以直接克隆 Gitee 上的镜像仓库，同步可能会存在时差。

git clone https://gitee.com/kele-bingtang/vitepress-theme-teek.git

依赖安装

只能用 pnpm 安装依赖。

pnpm install

Teek 本地包构建

pnpm to:theme stub

文档网站预览

pnpm docs:dev

代码提交

pnpm cz # 仅提交本地

pnpm czp # 提交远程

提示

如果需要分次提交，可以先执行 git add ./x/x，再执行 pnpm run git-cz，最后执行 git push origin dev（或者其他分支）。

Teek 打包

先构建 build 本地包

pnpm to:build stub

最后执行打包

pnpm build