Skip to content

Commit 61e17cc

Browse files
Kele-BingtangKele-Bingtang
authored
Merge pull request #31 from Kele-Bingtang/dev
refactor: ♻️ vitepress 改为 VitePress
2 parents ab48610 + f37b5db commit 61e17cc

File tree

44 files changed

+131
-131
lines changed

Some content is hidden

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

44 files changed

+131
-131
lines changed

‎build/helper/plugin.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import type { Plugin } from "rollup";
1313
// rollup 插件。rollup 本身只支持原生 JavaScript 文件打包，如果项目包含 vue、json 等非原生 JavaScript 文件，则利用插件来支持打包
1414
export const plugins = [
1515
vitepressThemeTeekClearConsole(),
16-
VitepressThemeTeekStyleAlias(),
16+
VitePressThemeTeekStyleAlias(),
1717
vuePlugin({ isProduction: true }),
1818
json(),
1919
// 解析和处理 Node.js 风格的模块导入语句（如 `import something from 'my-package'`），因为 Rollup 本身默认仅支持 ES 模块导入（即通过相对或绝对路径导入本地文件）
@@ -41,7 +41,7 @@ export const plugins = [
4141
/**
4242
* 将组件目录下的 style/*.ts 里的 ../../../styles 替换为实际的 vitepress-theme-teek 组件样式路径
4343
*/
44-
export function VitepressThemeTeekStyleAlias(): Plugin {
44+
export function VitePressThemeTeekStyleAlias(): Plugin {
4545
const themeChalk = "theme-chalk";
4646
const sourceThemeChalk = `@${PKG_NAME}/${themeChalk}`;
4747
const bundleThemeChalk = `${PKG_NAME}/${themeChalk}`;
@@ -61,7 +61,7 @@ export function VitepressThemeTeekStyleAlias(): Plugin {
6161
/**
6262
* 将组件目录下的 style/*.ts 里的 @element-plus 替换为实际的 element-plus 组件样式路径
6363
*/
64-
export function VitepressThemeTeekElementPlusAlias(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";

‎build/helper/util.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const cssResolver: any = {
88
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-
// 逻辑与 VitepressThemeTeekAlias、VitepressThemeTeekElementPlusAlias 方法一样（位于 ./plugin）
11+
// 逻辑与 VitePressThemeTeekAlias、VitePressThemeTeekElementPlusAlias 方法一样（位于 ./plugin）
1212
const sourceThemeChalk = `@${PKG_NAME}/theme-chalk`;
1313
const bundleThemeChalk = `${PKG_NAME}/theme-chalk`;
1414

‎build/tasks/modules.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
excludes,
1313
webTsConfig,
1414
tsOutput,
15-
VitepressThemeTeekElementPlusAlias,
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 = [VitepressThemeTeekElementPlusAlias(format), ...commonPlugins];
31+
const plugins = [VitePressThemeTeekElementPlusAlias(format), ...commonPlugins];
3232

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import "vitepress-theme-teek/vp-plus/container.scss"; // Markdown 容器样式
1515
// import "vitepress-theme-teek/vp-plus/container-left.scss"; // Markdown 容器左框样式
1616
// import "vitepress-theme-teek/vp-plus/container-flow.scss"; // Markdown 容器流体样式
1717
// import "vitepress-theme-teek/vp-plus/blockquote.scss"; // 引用样式
18-
// import "vitepress-theme-teek/vp-plus/index-rainbow.scss"; // Vitepress 首页彩虹渐变样式
18+
// import "vitepress-theme-teek/vp-plus/index-rainbow.scss"; // VitePress 首页彩虹渐变样式
1919
import "vitepress-theme-teek/tk-plus/banner-desc-gradient.scss"; // Banner 描述渐变样式
2020
import "vitepress-theme-teek/tk-plus/banner-full-img-scale.scss"; // Banner 全屏图片放大样式
2121

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export default defineConfig({
126126
["link", { rel: "icon", type: "image/png", href: "/teek-logo-mini.png" }],
127127
["meta", { property: "og:type", content: "website" }],
128128
["meta", { property: "og:locale", content: "zh-CN" }],
129-
["meta", { property: "og:title", content: "Teek | Vitepress Theme" }],
129+
["meta", { property: "og:title", content: "Teek | VitePress Theme" }],
130130
["meta", { property: "og:site_name", content: "Teek" }],
131131
["meta", { name: "author", content: "Teek" }],
132132
[

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export default defineConfig({
120120
["link", { rel: "icon", type: "image/png", href: "/teek-logo-mini.png" }],
121121
["meta", { property: "og:type", content: "website" }],
122122
["meta", { property: "og:locale", content: "zh-CN" }],
123-
["meta", { property: "og:title", content: "Teek | Vitepress Theme" }],
123+
["meta", { property: "og:title", content: "Teek | VitePress Theme" }],
124124
["meta", { name: "author", content: "Teek" }],
125125
[
126126
"meta",

‎docs/.vitepress/config.mts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { defineConfig } from "vitepress";
22
import { defineTeekConfig } from "vitepress-theme-teek/config";
33
import { version } from "vitepress-theme-teek/es/version";
44

5-
const description = ["vitepress-theme-teek 使用文档", "vitepress 主题框架"].toString();
5+
const description = ["vitepress-theme-teek 使用文档", "vitepress 主题"].toString();
66

77
const teekConfig = defineTeekConfig({
88
author: { name: "Teeker", link: "https://github.com/Kele-Bingtang" },
@@ -51,7 +51,7 @@ export default defineConfig({
5151
["link", { rel: "icon", type: "image/png", href: "/teek-logo-mini.png" }],
5252
["meta", { property: "og:type", content: "website" }],
5353
["meta", { property: "og:locale", content: "zh-CN" }],
54-
["meta", { property: "og:title", content: "Teek | Vitepress Theme" }],
54+
["meta", { property: "og:title", content: "Teek | VitePress Theme" }],
5555
["meta", { property: "og:site_name", content: "Teek" }],
5656
["meta", { property: "og:image", content: "" }],
5757
["meta", { property: "og:url", content: "" }],

‎docs/.vitepress/theme/config/teekConfig.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export const teekBlogConfig: TeekConfig = {
7474
{
7575
avatar: "https://theme.sugarat.top/logo.png",
7676
name: "粥里有勺糖",
77-
desc: "简约风的 Vitepress 博客主题",
77+
desc: "简约风的 VitePress 博客主题",
7878
link: "https://theme.sugarat.top/",
7979
},
8080
{

‎docs/01.指南/01.简介/01.简介.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ tags:
88
- 指南
99
---
1010

11-
Teek 是一个基于 Vitepress 构建的主题，是在默认主题的基础上进行拓展，支持 Vitepress 的所有功能、配置，可以零成本迁移过来。
11+
Teek 是一个基于 VitePress 构建的主题，是在默认主题的基础上进行拓展，支持 VitePress 的所有功能、配置，可以零成本迁移过来。
1212

1313
使用本主题可以很方便的搭建一个结构化的知识库或博客。
1414

1515
::: warning
1616

1717
- Node.js `18.0.0` 及以上版本
18-
- 在使用本主题前，要求至少会 Vitepress 的基本使用和默认主题的基本配置，然后再查看本文档
19-
- 本文档仅负责介绍 Teek 主题对 Vitepress 默认主题的扩展部分，更多配置请移步 [VitePress 中文文档](https://vitepress.dev/zh/)
18+
- 在使用本主题前，要求至少会 VitePress 的基本使用和默认主题的基本配置，然后再查看本文档
19+
- 本文档仅负责介绍 Teek 主题对 VitePress 默认主题的扩展部分，更多配置请移步 [VitePress 中文文档](https://vitepress.dev/zh/)
2020

2121
:::
2222

@@ -40,7 +40,7 @@ Teek 是一个基于 Vitepress 构建的主题，是在默认主题的基础上
4040

4141
## 拓展功能
4242

43-
相较于 Vitepress 主题，Teek 主要实现了博客风格的功能，部分功能也兼容文档风格，您现在正在阅读的是 Teek 的文档风格。
43+
相较于 VitePress 主题，Teek 主要实现了博客风格的功能，部分功能也兼容文档风格，您现在正在阅读的是 Teek 的文档风格。
4444

4545
> 全局
4646
@@ -68,7 +68,7 @@ Teek 是一个基于 Vitepress 构建的主题，是在默认主题的基础上
6868
- 文章信息：展示面包屑、作者、创建时间、更新时间、标签、分类、字数、阅读时长
6969
- 评论区：提供 `Giscus`、`Twikoo`、`Waline`、`Artalk` 四种评论提供商选择，并且支持自定义评论区
7070
- 代码块：UI 升级，支持一键折叠/展开
71-
- 文章页风格书页化：提供 3 种风格选择：Vitepress 原生、整体卡片化、片段卡片化
71+
- 文章页风格书页化：提供 3 种风格选择：VitePress 原生、整体卡片化、片段卡片化
7272
- ...
7373

74-
除了上述功能，Teek 也提供了 `CSS` 文件来增强 Vitepress 的样式。
74+
除了上述功能，Teek 也提供了 `CSS` 文件来增强 VitePress 的样式。

‎docs/01.指南/01.简介/10.快速开始.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ tags:
88
- 指南
99
top: true
1010
sticky: 1
11-
description: Teek 是一个基于 Vitepress 构建的主题，本文专门介绍如何快速安装 Teek。
11+
description: Teek 是一个基于 VitePress 构建的主题，本文专门介绍如何快速安装 Teek。
1212
---
1313

1414
## 版本
@@ -21,9 +21,9 @@ description: Teek 是一个基于 Vitepress 构建的主题，本文专门介绍
2121
- [yarn](https://classic.yarnpkg.com/lang/en/)
2222
- [npm](https://www.npmjs.com/)
2323

24-
## Vitepress 安装
24+
## VitePress 安装
2525

26-
有关 Vitepress 的安装教程来源于 [VitePress 文档](https://vitepress.dev/zh/guide/getting-started)。如果安装失败，请阅读 Vitepress 文档查看最新的安装教程。
26+
有关 VitePress 的安装教程来源于 [VitePress 文档](https://vitepress.dev/zh/guide/getting-started)。如果安装失败，请阅读 VitePress 文档查看最新的安装教程。
2727

2828
::: code-group
2929

@@ -114,7 +114,7 @@ npm install vitepress-theme-teek -D
114114

115115
## Teek 引入
116116

117-
根据 Vitepress 的要求，需要在 `.vitepress/theme/index.ts` 文件中引入 Teek 主题。如果没有该路径，需要先创建它：
117+
根据 VitePress 的要求，需要在 `.vitepress/theme/index.ts` 文件中引入 Teek 主题。如果没有该路径，需要先创建它：
118118

119119
```ts
120120
import Teek from "vitepress-theme-teek";
@@ -135,7 +135,7 @@ import { defineTeekConfig } from "vitepress-theme-teek/config";
135135
// Teek 主题配置
136136
const teekConfig = defineTeekConfig({});
137137

138-
// Vitepress 配置
138+
// VitePress 配置
139139
export default defineConfig({
140140
extends: teekConfig,
141141
// ...
@@ -180,9 +180,9 @@ npm run docs:dev
180180

181181
- 如果 `.vitepress` 和 Markdown 文档在项目根目录下，则 `vitepress dev docs` 改为 `vitepress dev`
182182
- 如果 `.vitepress` 和 Markdown 文档在项目 `src` 目录下，则 `vitepress dev docs` 改为 `vitepress dev src`
183-
- 如果 `.vitepress` 在项目根目录下，Markdown 文档放在 `src` 目录下，则 `vitepress dev docs` 改为 `vitepress dev`，且需要在 `.vitepress/config.ts` 里配置 `srcDir: src`，`srcDir` 的作用请看 [Vitepress - srcDir](https://vitepress.dev/zh/reference/site-config#srcdir)
183+
- 如果 `.vitepress` 在项目根目录下，Markdown 文档放在 `src` 目录下，则 `vitepress dev docs` 改为 `vitepress dev`，且需要在 `.vitepress/config.ts` 里配置 `srcDir: src`，`srcDir` 的作用请看 [VitePress - srcDir](https://vitepress.dev/zh/reference/site-config#srcdir)
184184

185-
总结：Vitepress 以 `.vitepress` 所在的目录层级 + `srcDir` 为参照逐层对 Markdown 文档扫描解析。
185+
总结：VitePress 以 `.vitepress` 所在的目录层级 + `srcDir` 为参照逐层对 Markdown 文档扫描解析。
186186

187187
## Teek 本地安装（可选）
188188

@@ -279,7 +279,7 @@ import { defineTeekConfig } from "./theme/teek/config";
279279
// Teek 主题配置
280280
const teekConfig = defineTeekConfig({});
281281

282-
// Vitepress 配置
282+
// VitePress 配置
283283
export default defineConfig({
284284
extends: teekConfig,
285285
// ...

0 commit comments

Comments
 (0)