Skip to content

Commit f304a04

Browse files
Kele-BingtangKele-Bingtang
committed
feat: 🚀 新增两个 markdown 卡片容器
1 parent 547705e commit f304a04

35 files changed

+1052
-24
lines changed

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ pnpm demo:localesRoot dev
4545
- 文章页基础信息支持配置到 h1 下
4646
- 全局公告、导航页面开发
4747
- vitepress-plugin-permalink 启动后给每个 md 自动生成永久链接
48+
- 样式打包
4849
- 主题使用文档编写
4950
- 部署测试、线上效果测试
5051
- 发布 NPM 库

‎build/helper/external.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@ export const globals = {
1212
"@element-plus/icons-vue": "ElementPlusIconsVue",
1313
"@giscus/vue": "Giscus",
1414
"@waline/client": "Waline",
15-
fsevents: "fsevents"
15+
fsevents: "fsevents",
16+
"markdown-it": "MarkdownIt",
17+
"markdown-it-container": "MarkdownItContainer",
1618
};
1719

1820
// 指定外部依赖，rollup 不会将这些依赖代码打包进去
19-
export const external = Object.keys(globals);
21+
export const external = [...Object.keys(globals), "@types/markdown-it", "@types/markdown-it-container"];

‎demo/docs-base/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"private": true,
3-
"name": "@vitepress-theme-teeker/docs",
3+
"name": "@vitepress-theme-teeker/docs-base",
44
"version": "1.0.0",
55
"description": "vitepress-theme-teeker 使用文档",
66
"type": "module",

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

+200
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
import { defineConfig } from "vitepress";
2+
import tkThemeConfig from "vitepress-theme-teeker/config";
3+
4+
const description = ["Hd Security 使用文档", "认证框架"].toString();
5+
6+
const tkConfig = tkThemeConfig({
7+
author: { name: "Tianke", link: "https://github.com/Kele-Bingtang" },
8+
blogger: {
9+
// 博主信息，显示在首页侧边栏
10+
avatar: " https://testingcf.jsdelivr.net/gh/Kele-Bingtang/static/user/avatar1.png",
11+
avatarStyle: "full",
12+
name: "天客",
13+
slogan: "朝圣的使徒，正在走向编程的至高殿堂！",
14+
},
15+
docAnalysis: {
16+
createTime: "2021-10-19",
17+
siteView: true,
18+
pageView: true,
19+
wordCount: true,
20+
readingTime: true,
21+
siteIteration: 2500,
22+
pageIteration: 2500,
23+
overrideInfo: [{ key: "lastActiveTime", value: (_, currentValue) => `${currentValue}前` }],
24+
appendInfo: [{ key: "index", label: "序号", value: "天客1024" }],
25+
},
26+
banner: {
27+
bgStyle: "bigImg",
28+
imgSrc: ["/img/bg1.jpg", "/img/bg2.png"],
29+
descStyle: "types",
30+
},
31+
// bodyBgImg: {
32+
// imgSrc: ["/img/bg1.jpg", "/img/bg2.png"],
33+
// },
34+
35+
// 首页顶部按 F11 开启壁纸模式
36+
wallpaper: {
37+
enabled: true,
38+
},
39+
40+
post: {
41+
coverImgMode: "default", // 封面大图
42+
},
43+
44+
friendLink: {
45+
list: [
46+
{ avatar: "/img/bg1.jpg", name: "测试1", desc: "这是一个友链测试1", link: "https://github.com/Kele-Bingtang" },
47+
{ avatar: "/img/ui.png", name: "测试2", desc: "这是一个友链测试2222111啊" },
48+
{ avatar: "/img/web.png", name: "测试3测试3测试3测试3测试3测试3", desc: "这是一个友链测试3" },
49+
{ avatar: "/img/more.png", name: "测试4", desc: "这是一个友链测试4" },
50+
{ avatar: "/img/ui.png", name: "测试22", desc: "这是一个友链测试2" },
51+
{ avatar: "/img/other.png", name: "测试11", desc: "这是一个友链测试1" },
52+
{ avatar: "/img/more.png", name: "测试44", desc: "这是一个友链测试4" },
53+
{ avatar: "/img/web.png", name: "测试33", desc: "这是一个友链测试3" },
54+
{ avatar: "/img/other.png", name: "测试111", desc: "这是一个友链测试1" },
55+
{ avatar: "/img/web.png", name: "测试333", desc: "这是一个友链测试3" },
56+
{ avatar: "/img/more.png", name: "测试444", desc: "这是一个友链测试4" },
57+
{ avatar: "/img/ui.png", name: "测试222", desc: "这是一个友链测试2" },
58+
],
59+
},
60+
61+
footerInfo: {
62+
message: ["下面的内容和图标都可以修改（本条内容也可以隐藏的）"],
63+
copyright: {
64+
createYear: 2021,
65+
suffix: "天客 Blog",
66+
},
67+
icpRecord: {
68+
name: "桂ICP备2021009994号",
69+
link: "http://beian.miit.gov.cn/",
70+
},
71+
},
72+
social: [
73+
{
74+
icon: "icon-github",
75+
iconType: "iconfont",
76+
name: "GitHub",
77+
link: "https://github.com/kele-bingtang",
78+
},
79+
{
80+
icon: "icon-gitee2",
81+
iconType: "iconfont",
82+
name: "Gitee",
83+
link: "https://gitee.com/kele-bingtang",
84+
},
85+
{
86+
icon: "icon-qq",
87+
iconType: "iconfont",
88+
name: "QQ",
89+
link: "http://wpa.qq.com/msgrd?v=3&uin=28761025&site=qq&menu=yes",
90+
},
91+
{
92+
icon: "icon-mobile",
93+
iconType: "iconfont",
94+
name: "联系我",
95+
link: "https://www.youngkbt.cn/?contact=true",
96+
},
97+
],
98+
comment: {
99+
provider: "giscus",
100+
options: {
101+
// twikoo 配置，官网：https://twikoo.js.org/
102+
// envId: "https://twikoo.youngkbt.cn/",
103+
// link: "https://cdn.jsdelivr.net/npm/[email protected]/dist/twikoo.min.js",
104+
105+
// waline 配置，官网：https://waline.js.org/
106+
// serverURL: "https://tk.waline.youngkbt.cn/",
107+
// jsLink: "https://unpkg.com/@waline/client@v3/dist/waline.js",
108+
// cssLink: "https://unpkg.com/@waline/client@v3/dist/waline.css",
109+
110+
// giscus 配置，官网：https://giscus.app/zh-CN
111+
repo: "Kele-Bingtang/vitepress-theme-kt",
112+
repoId: "R_kgDONpVfBA",
113+
category: "Announcements",
114+
categoryId: "DIC_kwDONpVfBM4Cm3v9",
115+
116+
// artalk 配置，官网：https://artalk.js.org/
117+
// server: "",
118+
// site: "",
119+
},
120+
},
121+
});
122+
123+
// https://vitepress.dev/reference/site-config
124+
export default defineConfig({
125+
extends: tkConfig,
126+
base: "/",
127+
title: "Hd Security",
128+
description: description,
129+
cleanUrls: true,
130+
lastUpdated: true,
131+
lang: "zh-CN",
132+
head: [
133+
["meta", { name: "author", content: "Tianke" }],
134+
[
135+
"meta",
136+
{
137+
name: "viewport",
138+
content: "width=device-width,initial-scale=1,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no",
139+
},
140+
],
141+
[
142+
"meta",
143+
{
144+
name: "description",
145+
description,
146+
},
147+
],
148+
["meta", { name: "keywords", description }],
149+
["link", { rel: "icon", href: "/favicon.ico", type: "image/png" }],
150+
["link", { rel: "stylesheet", href: "//at.alicdn.com/t/font_2989306_w303erbip9.css" }], // 阿里在线矢量库
151+
],
152+
markdown: {
153+
// 开启行号
154+
lineNumbers: true,
155+
image: {
156+
// 默认禁用；设置为 true 可为所有图片启用懒加载。
157+
lazyLoading: true,
158+
},
159+
// 更改容器默认值标题
160+
container: {
161+
tipLabel: "提示",
162+
warningLabel: "警告",
163+
dangerLabel: "危险",
164+
infoLabel: "信息",
165+
detailsLabel: "详细信息",
166+
},
167+
},
168+
themeConfig: {
169+
// https://vitepress.dev/reference/default-theme-config
170+
logo: " https://testingcf.jsdelivr.net/gh/Kele-Bingtang/static/user/avatar1.png",
171+
darkModeSwitchLabel: "主题",
172+
sidebarMenuLabel: "菜单",
173+
returnToTopLabel: "返回顶部",
174+
lastUpdatedText: "上次更新时间",
175+
outline: {
176+
level: [2, 4],
177+
label: "本页导航",
178+
},
179+
docFooter: {
180+
prev: "上一页",
181+
next: "下一页",
182+
},
183+
nav: [
184+
{ text: "首页", link: "/" },
185+
{ text: "指南", link: "/01.指南/" },
186+
{ text: "设计", link: "/design" },
187+
{ text: "API", link: "/07.API/01.API - 登录" },
188+
{ text: "归档", link: "/archives" },
189+
],
190+
socialLinks: [{ icon: "github", link: "https://github.com/Kele-Bingtang/hd-security" }],
191+
192+
search: {
193+
provider: "local",
194+
},
195+
editLink: {
196+
text: "在 GitHub 上编辑此页",
197+
pattern: "https://github.com/Kele-Bingtang/hd-security/edit/master/hd-security-docs/docs/:path",
198+
},
199+
},
200+
});

‎demo/docs-test/.vitepress/sidebar.ts

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
export default {
2+
"/01.指南/": [
3+
{
4+
text: "简介",
5+
items: [{ text: "简介", link: "/01.指南/index" }],
6+
},
7+
{
8+
text: "使用",
9+
items: [
10+
{
11+
text: "登录认证",
12+
link: "/01.指南/01.指南 - 使用/04.使用 - 登录认证",
13+
},
14+
{
15+
text: "权限认证",
16+
link: "/01.指南/01.指南 - 使用/07.使用 - 权限认证",
17+
},
18+
{
19+
text: "登出下线",
20+
link: "/01.指南/01.指南 - 使用/10.使用 - 登出下线",
21+
},
22+
{
23+
text: "注解鉴权",
24+
link: "/01.指南/01.指南 - 使用/13.使用 - 注解鉴权",
25+
},
26+
{
27+
text: "路由拦截鉴权",
28+
link: "/01.指南/01.指南 - 使用/16.使用 - 路由拦截鉴权",
29+
},
30+
{
31+
text: "Session 会话",
32+
link: "/01.指南/01.指南 - 使用/19.使用 - Session 会话",
33+
},
34+
{
35+
text: "框架配置",
36+
link: "/01.指南/01.指南 - 使用/22.使用 - 框架配置",
37+
},
38+
{
39+
text: "自定义 Token",
40+
link: "/01.指南/01.指南 - 使用/25.使用 - 自定义 Token",
41+
},
42+
{
43+
text: "临时 Token 认证",
44+
link: "/01.指南/01.指南 - 使用/28.使用 - 临时 Token 认证",
45+
},
46+
{
47+
text: "记住我模式",
48+
link: "/01.指南/01.指南 - 使用/31.使用 - 记住我模式",
49+
},
50+
{
51+
text: "二级认证",
52+
link: "/01.指南/01.指南 - 使用/34.使用 - 二级认证",
53+
},
54+
{
55+
text: "身份切换",
56+
link: "/01.指南/01.指南 - 使用/37.使用 - 身份切换",
57+
},
58+
{
59+
text: "账号封禁",
60+
link: "/01.指南/01.指南 - 使用/40.使用 - 账号封禁",
61+
},
62+
{
63+
text: "会话查询",
64+
link: "/01.指南/01.指南 - 使用/43.使用 - 会话查询",
65+
},
66+
{
67+
text: "Http Basic 认证",
68+
link: "/01.指南/01.指南 - 使用/46.使用 - Http Basic 认证",
69+
},
70+
{
71+
text: "全局侦听器",
72+
link: "/01.指南/01.指南 - 使用/49.使用 - 全局侦听器",
73+
},
74+
{
75+
text: "全局过滤器",
76+
link: "/01.指南/01.指南 - 使用/52.使用 - 全局过滤器",
77+
},
78+
{
79+
text: "多账号认证",
80+
link: "/01.指南/01.指南 - 使用/55.使用 - 多账号认证",
81+
},
82+
{
83+
text: "自定义注解",
84+
link: "/01.指南/01.指南 - 使用/58.使用 - 自定义注解",
85+
},
86+
],
87+
},
88+
{
89+
text: "环境",
90+
items: [
91+
{
92+
text: "集成 Spring Boot",
93+
link: "/01.指南/05.指南 - 环境集成/04.环境集成 - Spring Boot",
94+
},
95+
{
96+
text: "集成 WebFlux",
97+
link: "/01.指南/05.指南 - 环境集成/07.环境集成 - Spring WebFlux",
98+
},
99+
{
100+
text: "上下文组件开发指南",
101+
link: "/01.指南/05.指南 - 环境集成/99.环境集成 - 上下文组件开发指南",
102+
},
103+
],
104+
},
105+
{
106+
text: "插件",
107+
items: [
108+
{
109+
text: "持久层集成 Redis",
110+
link: "/01.指南/10.指南 - 插件/04.插件 - 持久层集成 Redis",
111+
},
112+
{
113+
text: "持久层拓展",
114+
link: "/01.指南/10.指南 - 插件/07.插件 - 持久层拓展",
115+
},
116+
{
117+
text: "AOP 注解鉴权",
118+
link: "/01.指南/10.指南 - 插件/10.插件 - AOP 注解鉴权",
119+
},
120+
{
121+
text: "Token 集成 JWT",
122+
link: "/01.指南/10.指南 - 插件/13.插件 - Token 集成 JWT",
123+
},
124+
{
125+
text: "插件开发指南",
126+
link: "/01.指南/10.指南 - 插件/99.插件 - 插件开发指南",
127+
},
128+
],
129+
},
130+
],
131+
"/05.设计/": [
132+
{
133+
text: "思路",
134+
items: [{ text: "思路设计", link: "/05.设计/01.设计 - 思路/01.设计 - 思路设计" }],
135+
},
136+
],
137+
};

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

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import teeker from "vitepress-theme-teeker";
2+
// import "vitepress-theme-teeker/index.css";
3+
4+
export default {
5+
extends: teeker,
6+
};

0 commit comments

Comments
 (0)