Skip to content

Commit dfdcf4a

Browse files
Kele-BingtangKele-Bingtang
committed
feat: 🚀 teeker 改为 teek
1 parent 93a99c6 commit dfdcf4a

File tree

457 files changed

+789
-749
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

457 files changed

+789
-749
lines changed

‎.vscode/settings.json

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
"artalk",
7575
"giscus",
7676
"teeker",
77+
"teek",
7778
"frontmatter",
7879
"onwarn",
7980
"busuanzi",

‎README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# vitepress-theme-teeker
1+
# vitepress-theme-teek
22

33
基础功能已完成开发，剩余加强功能请看下面的 TODO。
44

@@ -7,7 +7,7 @@
77
项目拉取
88

99
```bash
10-
git clone https://github.com/Kele-Bingtang/vitepress-theme-teeker.git
10+
git clone https://github.com/Kele-Bingtang/vitepress-theme-teek.git
1111
```
1212

1313
依赖安装（只能用 pnpm 安装依赖）
@@ -51,7 +51,6 @@ pnpm plugin:build
5151

5252
## TODO
5353

54-
- Teeker 改为 Teek
5554
- 主题使用文档编写
5655
- 部署测试、线上效果测试
5756
- 发布 NPM 库

‎build/helper/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ export * from "./external";
55
export * from "./plugin";
66

77
export const target = "es2020";
8-
export const PKG_CAMEL_CASE_NAME = "Teeker";
8+
export const PKG_CAMEL_CASE_NAME = "Teek";

‎build/helper/path.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { resolve } from "path";
22

3-
export const PKG_NAME = "vitepress-theme-teeker";
3+
export const PKG_NAME = "vitepress-theme-teek";
44

55
/** 项目根目录 `/` */
66
export const projectRoot = resolve(__dirname, "../../");
7-
/** vitepress-theme-teeker 目录 即 `/vitepress-theme-teeker` */
7+
/** vitepress-theme-teek 目录 即 `/vitepress-theme-teek` */
88
export const tkRoot = resolve(projectRoot, PKG_NAME);
99

10-
/** 组件目录 `/vitepress-theme-teeker/components` */
10+
/** 组件目录 `/vitepress-theme-teek/components` */
1111
export const compRoot = resolve(tkRoot, "components");
1212

1313
/** Docs */
@@ -17,7 +17,7 @@ export const vpRoot = resolve(docRoot, ".vitepress");
1717

1818
/** `/dist` */
1919
export const buildOutput = resolve(projectRoot, "dist");
20-
/** `/dist/vitepress-theme-teeker` */
20+
/** `/dist/vitepress-theme-teek` */
2121
export const tkOutput = resolve(buildOutput, PKG_NAME);
2222
/** /dist/types */
2323
export const tsOutput = resolve(buildOutput, "types");
@@ -29,5 +29,5 @@ export const docPackage = resolve(docRoot, "package.json");
2929
/** /tsconfig.web.json */
3030
export const webTsConfig = resolve(projectRoot, "tsconfig.web.json");
3131

32-
/** /dist/vitepress-theme-teeker/theme-chalk */
32+
/** /dist/vitepress-theme-teek/theme-chalk */
3333
export const tcOutput = resolve(tkOutput, "theme-chalk");

‎build/helper/plugin.ts

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import type { Plugin } from "rollup";
1212

1313
// rollup 插件。rollup 本身只支持原生 JavaScript 文件打包，如果项目包含 vue、json 等非原生 JavaScript 文件，则利用插件来支持打包
1414
export const plugins = [
15-
vitepressThemeTeekerClearConsole(),
16-
VitepressThemeTeekerStyleAlias(),
15+
vitepressThemeTeekClearConsole(),
16+
VitepressThemeTeekStyleAlias(),
1717
vuePlugin({ isProduction: true }),
1818
json(),
1919
// 解析和处理 Node.js 风格的模块导入语句（如 `import something from 'my-package'`），因为 Rollup 本身默认仅支持 ES 模块导入（即通过相对或绝对路径导入本地文件）
@@ -39,15 +39,15 @@ export const plugins = [
3939
];
4040

4141
/**
42-
* 将组件目录下的 style/*.ts 里的 ../../../styles 替换为实际的 vitepress-theme-teeker 组件样式路径
42+
* 将组件目录下的 style/*.ts 里的 ../../../styles 替换为实际的 vitepress-theme-teek 组件样式路径
4343
*/
44-
export function VitepressThemeTeekerStyleAlias(): Plugin {
44+
export function VitepressThemeTeekStyleAlias(): Plugin {
4545
const themeChalk = "theme-chalk";
4646
const sourceThemeChalk = `@${PKG_NAME}/${themeChalk}`;
4747
const bundleThemeChalk = `${PKG_NAME}/${themeChalk}`;
4848

4949
return {
50-
name: "vitepress-theme-teeker-alias-plugin",
50+
name: "vitepress-theme-teek-alias-plugin",
5151
resolveId(id) {
5252
if (!id.startsWith(sourceThemeChalk)) return;
5353
return {
@@ -61,14 +61,14 @@ export function VitepressThemeTeekerStyleAlias(): Plugin {
6161
/**
6262
* 将组件目录下的 style/*.ts 里的 @element-plus 替换为实际的 element-plus 组件样式路径
6363
*/
64-
export function VitepressThemeTeekerElementPlusAlias(format: "esm" | "cjs"): Plugin {
64+
export function VitepressThemeTeekElementPlusAlias(format: "esm" | "cjs"): Plugin {
6565
const sourceName = `@element-plus`;
6666
const module = format === "esm" ? "es" : "lib";
6767
const ext = format === "esm" ? ".mjs" : ".js";
6868
const bundleStyle = `element-plus/${module}/components`;
6969

7070
return {
71-
name: "vitepress-theme-teeker-element-plus-alias-plugin",
71+
name: "vitepress-theme-teek-element-plus-alias-plugin",
7272
resolveId(id) {
7373
if (!id.startsWith(sourceName)) return;
7474
return {
@@ -82,10 +82,10 @@ export function VitepressThemeTeekerElementPlusAlias(format: "esm" | "cjs"): Plu
8282
/**
8383
* 清除 console.log
8484
*/
85-
export function vitepressThemeTeekerClearConsole(): Plugin {
85+
export function vitepressThemeTeekClearConsole(): Plugin {
8686
const reg = /console\.log\([^)]*\);?\n?/g;
8787
return {
88-
name: "vitepress-theme-teeker-clear-console-plugin",
88+
name: "vitepress-theme-teek-clear-console-plugin",
8989
transform(code, id) {
9090
if (id.endsWith(".ts") || id.endsWith(".vue")) {
9191
const transformedCode = code.replace(reg, "");

‎build/helper/util.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ import { PKG_NAME, tkRoot } from "./path";
55
* dts 插件生成 .d.ts 文件时，默认会把组件目录下的 styles/*.ts 内容去掉，这里让插件保留
66
*/
77
export const cssResolver: any = {
8-
name: "vitepress-theme-teeker-css-resolver",
8+
name: "vitepress-theme-teek-css-resolver",
99
supports: (id: string) => id.includes("/style/css.ts") || id.includes("/style/index.ts"),
1010
transform: ({ id, code }: { id: string; code: string }) => {
11-
// 逻辑与 VitepressThemeTeekerAlias、VitepressThemeTeekerElementPlusAlias 方法一样（位于 ./plugin）
11+
// 逻辑与 VitepressThemeTeekAlias、VitepressThemeTeekElementPlusAlias 方法一样（位于 ./plugin）
1212
const sourceThemeChalk = `@${PKG_NAME}/theme-chalk`;
1313
const bundleThemeChalk = `${PKG_NAME}/theme-chalk`;
1414

‎build/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"private": true,
3-
"name": "@vitepress-theme-teeker/build",
3+
"name": "@vitepress-theme-teek/build",
44
"version": "1.0.0",
5-
"description": "Build Toolchain for vitepress-theme-teeker",
5+
"description": "Build Toolchain for vitepress-theme-teek",
66
"main": "./dist/index.cjs",
77
"module": "./dist/index.mjs",
88
"types": "./dist/index.d.ts",

‎build/tasks/modules.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
excludes,
1313
webTsConfig,
1414
tsOutput,
15-
VitepressThemeTeekerElementPlusAlias,
15+
VitepressThemeTeekElementPlusAlias,
1616
} from "../helper";
1717
import { cssResolver } from "../helper/util";
1818

@@ -28,7 +28,7 @@ const buildModules = async () => {
2828
* 根据 format 生成对应的 bundle
2929
*/
3030
const getBundles = async (format: "esm" | "cjs") => {
31-
const plugins = [VitepressThemeTeekerElementPlusAlias(format), ...commonPlugins];
31+
const plugins = [VitepressThemeTeekElementPlusAlias(format), ...commonPlugins];
3232

3333
if (format === "esm") {
3434
// 添加构建 Typescript 类型插件

‎build/theme-chalk.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { copy } from "fs-extra";
1212

1313
const isDev = process.env.THEME_CHALK_DEV === "true";
1414

15-
/** /vitepress-theme-teeker/src/styles */
15+
/** /vitepress-theme-teek/src/styles */
1616
const styleRoot = resolve(tkRoot, "src/styles");
1717
/** ./dist/theme-chalk */
1818
const distRoot = resolve(__dirname, "dist/theme-chalk");
@@ -48,10 +48,10 @@ const buildStyle = async () => {
4848
// 复制源文件到 ./dist/theme-chalk/src
4949
await copy(styleRoot, resolve(distRoot, "src"));
5050

51-
// 复制打包后的文件 ./dist/theme-chalk 到 /dist/vitepress-theme-teeker/theme-chalk
51+
// 复制打包后的文件 ./dist/theme-chalk 到 /dist/vitepress-theme-teek/theme-chalk
5252
await copy(distRoot, resolve(tcOutput));
5353

54-
// 复制打包后的 /dist/index.css 文件到 /dist/vitepress-theme-teeker/index.css
54+
// 复制打包后的 /dist/index.css 文件到 /dist/vitepress-theme-teek/index.css
5555
// await copy(resolve(distRoot, "index.css"), resolve(tkOutput, "index.css"));
5656
};
5757

‎demo/docs-base/.vitepress/config.mts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
import { title } from "process";
21
import { defineConfig } from "vitepress";
3-
import tkThemeConfig from "vitepress-theme-teeker/config";
2+
import tkThemeConfig from "vitepress-theme-teek/config";
43

54
const description = ["Hd Security 使用文档", "认证框架"].toString();
65

‎demo/docs-base/.vitepress/theme/components/BannerImgArrow.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<script setup lang="ts" name="BannerImgArrow">
2-
import { TkIcon } from "vitepress-theme-teeker";
2+
import { TkIcon } from "vitepress-theme-teek";
33
import arrowSvg from "../svg/arrow";
44
55
const handleClickArrow = () => {

‎demo/docs-base/.vitepress/theme/index.ts

+54-54
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
import Teeker from "vitepress-theme-teeker";
1+
import Teek from "vitepress-theme-teek";
22
import NoticeContent from "./components/NoticeContent.vue";
33
import BannerImgArrow from "./components/BannerImgArrow.vue";
44
import { defineComponent, h, nextTick, watch } from "vue";
55
import { useData } from "vitepress";
6-
// import "vitepress-theme-teeker/index.css";
7-
import "vitepress-theme-teeker/vp-plus/code-block-mobile.scss"; // 移动端代码块样式加 padding
8-
import "vitepress-theme-teeker/vp-plus/sidebar.scss"; // 侧边栏字体样式
9-
import "vitepress-theme-teeker/vp-plus/nav.scss"; // 导航栏样式
10-
// import "vitepress-theme-teeker/vp-plus/nav-blur.scss"; // 导航栏毛玻璃样式
11-
import "vitepress-theme-teeker/vp-plus/aside.scss"; // 文章目录样式
12-
import "vitepress-theme-teeker/vp-plus/doc-h1-gradient.scss"; // 文档以及标题样式
13-
import "vitepress-theme-teeker/vp-plus/mark.scss"; // 文章 mark 标签样式
14-
import "vitepress-theme-teeker/vp-plus/container.scss"; // Markdown 容器样式
15-
// import "vitepress-theme-teeker/vp-plus/container-left.scss"; // Markdown 容器左框样式
16-
// import "vitepress-theme-teeker/vp-plus/container-flow.scss"; // Markdown 容器流体样式
17-
// import "vitepress-theme-teeker/vp-plus/blockquote.scss"; // 引用样式
18-
// import "vitepress-theme-teeker/vp-plus/index-rainbow.scss"; // Vitepress 首页彩虹渐变样式
19-
import "vitepress-theme-teeker/tk-plus/banner-desc-gradient.scss"; // Banner 描述渐变样式
20-
import "vitepress-theme-teeker/tk-plus/banner-full-img-scale.scss";
6+
// import "vitepress-theme-teek/index.css";
7+
import "vitepress-theme-teek/vp-plus/code-block-mobile.scss"; // 移动端代码块样式加 padding
8+
import "vitepress-theme-teek/vp-plus/sidebar.scss"; // 侧边栏字体样式
9+
import "vitepress-theme-teek/vp-plus/nav.scss"; // 导航栏样式
10+
// import "vitepress-theme-teek/vp-plus/nav-blur.scss"; // 导航栏毛玻璃样式
11+
import "vitepress-theme-teek/vp-plus/aside.scss"; // 文章目录样式
12+
import "vitepress-theme-teek/vp-plus/doc-h1-gradient.scss"; // 文档以及标题样式
13+
import "vitepress-theme-teek/vp-plus/mark.scss"; // 文章 mark 标签样式
14+
import "vitepress-theme-teek/vp-plus/container.scss"; // Markdown 容器样式
15+
// import "vitepress-theme-teek/vp-plus/container-left.scss"; // Markdown 容器左框样式
16+
// import "vitepress-theme-teek/vp-plus/container-flow.scss"; // Markdown 容器流体样式
17+
// import "vitepress-theme-teek/vp-plus/blockquote.scss"; // 引用样式
18+
// import "vitepress-theme-teek/vp-plus/index-rainbow.scss"; // Vitepress 首页彩虹渐变样式
19+
import "vitepress-theme-teek/tk-plus/banner-desc-gradient.scss"; // Banner 描述渐变样式
20+
import "vitepress-theme-teek/tk-plus/banner-full-img-scale.scss";
2121

2222
import { useFooterRuntime } from "./helper/useFooterRuntime"; // 首页底部添加运行时间
2323

2424
export default {
25-
extends: Teeker,
25+
extends: Teek,
2626
Layout: defineComponent({
2727
name: "LayoutProvider",
2828
setup() {
@@ -41,47 +41,47 @@ export default {
4141
);
4242

4343
return () =>
44-
h(Teeker.Layout, null, {
45-
"teeker-notice-content": () => h(NoticeContent),
46-
"teeker-home-banner-feature-after": () => h(BannerImgArrow),
44+
h(Teek.Layout, null, {
45+
"teek-notice-content": () => h(NoticeContent),
46+
"teek-home-banner-feature-after": () => h(BannerImgArrow),
4747

48-
// "teeker-home-before": () => h("div", null, "teeker-home-before"),
49-
// "teeker-home-after": () => h("div", null, "teeker-home-after"),
50-
// "teeker-home-banner-before": () => h("div", null, "teeker-home-banner-before"),
51-
// "teeker-home-banner-after": () => h("div", null, "teeker-home-banner-after"),
52-
// "teeker-home-post-before": () => h("div", null, "teeker-home-post-before"),
53-
// "teeker-home-post-after": () => h("div", null, "teeker-home-post-after"),
54-
// "teeker-home-info-before": () => h("div", null, "teeker-home-info-before"),
55-
// "teeker-home-info-after": () => h("div", null, "teeker-home-info-after"),
56-
// "teeker-home-my-before": () => h("div", null, "teeker-home-my-before"),
57-
// "teeker-home-my-after": () => h("div", null, "teeker-home-my-after"),
58-
// "teeker-home-top-article-before": () => h("div", null, "teeker-home-top-article-before"),
59-
// "teeker-home-top-article-after": () => h("div", null, "teeker-home-top-article-after"),
60-
// "teeker-home-category-before": () => h("div", null, "teeker-home-category-before"),
61-
// "teeker-home-category-after": () => h("div", null, "teeker-home-category-after"),
62-
// "teeker-home-tag-before": () => h("div", null, "teeker-home-tag-before"),
63-
// "teeker-home-tag-after": () => h("div", null, "teeker-home-tag-after"),
64-
// "teeker-home-friend-link-before": () => h("div", null, "teeker-home-friend-link-before"),
65-
// "teeker-home-friend-link-after": () => h("div", null, "teeker-home-friend-link-after"),
66-
// "teeker-home-doc-analysis-before": () => h("div", null, "teeker-home-doc-analysis-before"),
67-
// "teeker-home-doc-analysis-after": () => h("div", null, "teeker-home-doc-analysis-after"),
68-
// "teeker-footer-before": () => h("div", null, "teeker-footer-before"),
69-
// "teeker-footer-after": () => h("div", null, "teeker-footer-after"),
48+
// "teek-home-before": () => h("div", null, "teek-home-before"),
49+
// "teek-home-after": () => h("div", null, "teek-home-after"),
50+
// "teek-home-banner-before": () => h("div", null, "teek-home-banner-before"),
51+
// "teek-home-banner-after": () => h("div", null, "teek-home-banner-after"),
52+
// "teek-home-post-before": () => h("div", null, "teek-home-post-before"),
53+
// "teek-home-post-after": () => h("div", null, "teek-home-post-after"),
54+
// "teek-home-info-before": () => h("div", null, "teek-home-info-before"),
55+
// "teek-home-info-after": () => h("div", null, "teek-home-info-after"),
56+
// "teek-home-my-before": () => h("div", null, "teek-home-my-before"),
57+
// "teek-home-my-after": () => h("div", null, "teek-home-my-after"),
58+
// "teek-home-top-article-before": () => h("div", null, "teek-home-top-article-before"),
59+
// "teek-home-top-article-after": () => h("div", null, "teek-home-top-article-after"),
60+
// "teek-home-category-before": () => h("div", null, "teek-home-category-before"),
61+
// "teek-home-category-after": () => h("div", null, "teek-home-category-after"),
62+
// "teek-home-tag-before": () => h("div", null, "teek-home-tag-before"),
63+
// "teek-home-tag-after": () => h("div", null, "teek-home-tag-after"),
64+
// "teek-home-friend-link-before": () => h("div", null, "teek-home-friend-link-before"),
65+
// "teek-home-friend-link-after": () => h("div", null, "teek-home-friend-link-after"),
66+
// "teek-home-doc-analysis-before": () => h("div", null, "teek-home-doc-analysis-before"),
67+
// "teek-home-doc-analysis-after": () => h("div", null, "teek-home-doc-analysis-after"),
68+
// "teek-footer-before": () => h("div", null, "teek-footer-before"),
69+
// "teek-footer-after": () => h("div", null, "teek-footer-after"),
7070

71-
// "teeker-article-analyze-before": () => h("div", null, "teeker-article-analyze-before"),
72-
// "teeker-article-analyze-after": () => h("div", null, "teeker-article-analyze-after"),
73-
// "teeker-comment-before": () => h("div", null, "teeker-comment-before"),
74-
// "teeker-comment-after": () => h("div", null, "teeker-comment-after"),
75-
// "teeker-page-top-before": () => h("div", null, "teeker-page-top-before"),
76-
// "teeker-page-top-after": () => h("div", null, "teeker-page-top-after"),
71+
// "teek-article-analyze-before": () => h("div", null, "teek-article-analyze-before"),
72+
// "teek-article-analyze-after": () => h("div", null, "teek-article-analyze-after"),
73+
// "teek-comment-before": () => h("div", null, "teek-comment-before"),
74+
// "teek-comment-after": () => h("div", null, "teek-comment-after"),
75+
// "teek-page-top-before": () => h("div", null, "teek-page-top-before"),
76+
// "teek-page-top-after": () => h("div", null, "teek-page-top-after"),
7777

78-
// "teeker-archives-top-before": () => h("div", null, "teeker-archives-top-before"),
79-
// "teeker-archives-top-after": () => h("div", null, "teeker-archives-top-after"),
80-
// "teeker-catalogue-top-before": () => h("div", null, "teeker-catalogue-top-before"),
81-
// "teeker-catalogue-top-after": () => h("div", null, "teeker-catalogue-top-after"),
78+
// "teek-archives-top-before": () => h("div", null, "teek-archives-top-before"),
79+
// "teek-archives-top-after": () => h("div", null, "teek-archives-top-after"),
80+
// "teek-catalogue-top-before": () => h("div", null, "teek-catalogue-top-before"),
81+
// "teek-catalogue-top-after": () => h("div", null, "teek-catalogue-top-after"),
8282

83-
// "teeker-right-bottom-before": () => h("div", null, "teeker-right-bottom-before"),
84-
// "teeker-right-bottom-after": () => h("div", null, "teeker-right-bottom-after"),
83+
// "teek-right-bottom-before": () => h("div", null, "teek-right-bottom-before"),
84+
// "teek-right-bottom-after": () => h("div", null, "teek-right-bottom-after"),
8585
});
8686
},
8787
}),

‎demo/docs-base/02.Markdown 拓展.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -143,16 +143,16 @@ data:
143143

144144
效果：
145145

146-
- <mark>Teeker</mark>
146+
- <mark>Teek</mark>
147147

148148
使用：
149149

150150
```html
151151
-
152-
<mark>Teeker</mark>
152+
<mark>Teek</mark>
153153
```
154154

155-
## Teeker 内置容器
155+
## Teek 内置容器
156156

157157
NOTE 容器
158158

@@ -187,7 +187,7 @@ NOTE 容器
187187

188188
::: right
189189

190-
2021-11-13 @Teeker
190+
2021-11-13 @Teek
191191

192192
:::
193193

‎demo/docs-base/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"private": true,
3-
"name": "@vitepress-theme-teeker/docs-base",
3+
"name": "@vitepress-theme-teek/docs-base",
44
"version": "1.0.0",
5-
"description": "vitepress-theme-teeker 使用文档",
5+
"description": "vitepress-theme-teek 使用文档",
66
"type": "module",
77
"scripts": {
88
"dev": "vitepress dev",
@@ -11,6 +11,6 @@
1111
},
1212
"devDependencies": {
1313
"vitepress": "^1.6.3",
14-
"vitepress-theme-teeker": "workspace:*"
14+
"vitepress-theme-teek": "workspace:*"
1515
}
1616
}

‎demo/docs-locales-root/.vitepress/locales/shared.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { defineConfig } from "vitepress";
2-
import tkThemeConfig from "vitepress-theme-teeker/config";
2+
import tkThemeConfig from "vitepress-theme-teek/config";
33

44
const tkConfig = tkThemeConfig({
55
author: { name: "Tianke", link: "https://github.com/Kele-Bingtang" },

0 commit comments

Comments
 (0)