@ruan-cat/vitepress-preset-config 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/config.mjs +5 -13
- package/package.json +2 -2
- package/src/.vitepress/config.mts +13 -1
- package/src/config.mts +5 -13
package/dist/config.mjs
CHANGED
|
@@ -37,8 +37,8 @@ function setGenerateSidebar(options) {
|
|
|
37
37
|
return generateSidebar(getMergeSidebarOptions(options));
|
|
38
38
|
}
|
|
39
39
|
var defaultUserConfig = {
|
|
40
|
-
title: "
|
|
41
|
-
description: "\
|
|
40
|
+
title: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u6807\u9898",
|
|
41
|
+
description: "\u8BF7\u586B\u5199\u6709\u610F\u4E49\u7684\u63CF\u8FF0",
|
|
42
42
|
lang: "zh",
|
|
43
43
|
// 暂不需要
|
|
44
44
|
// srcDir: "./src",
|
|
@@ -48,12 +48,7 @@ var defaultUserConfig = {
|
|
|
48
48
|
provider: "local"
|
|
49
49
|
},
|
|
50
50
|
// https://vitepress.dev/reference/default-theme-config
|
|
51
|
-
nav: [
|
|
52
|
-
{ text: "\u9996\u9875", link: "/" },
|
|
53
|
-
{ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" }
|
|
54
|
-
// TODO: 未来项目结束时，在此补充配置
|
|
55
|
-
// { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
|
|
56
|
-
],
|
|
51
|
+
nav: [{ text: "\u9996\u9875", link: "/" }],
|
|
57
52
|
outline: {
|
|
58
53
|
label: "\u672C\u9875\u76EE\u5F55",
|
|
59
54
|
level: "deep"
|
|
@@ -63,7 +58,7 @@ var defaultUserConfig = {
|
|
|
63
58
|
socialLinks: [
|
|
64
59
|
{
|
|
65
60
|
icon: "github",
|
|
66
|
-
link: "https://github.com/ruan-cat
|
|
61
|
+
link: "https://github.com/ruan-cat"
|
|
67
62
|
}
|
|
68
63
|
]
|
|
69
64
|
},
|
|
@@ -115,10 +110,7 @@ function handleChangeLog(userConfig) {
|
|
|
115
110
|
consola.error(` \u5F53\u524D\u7684\u7528\u6237\u914D\u7F6E\u4E3A\uFF1A `, userConfig);
|
|
116
111
|
throw new Error(` nav \u9ED8\u8BA4\u63D0\u4F9B\u7684\u5BFC\u822A\u680F\u914D\u7F6E\u4E3A\u7A7A\u3002\u4E0D\u7B26\u5408\u9ED8\u8BA4\u914D\u7F6E\uFF0C\u8BF7\u68C0\u67E5\u3002 `);
|
|
117
112
|
}
|
|
118
|
-
nav.push({
|
|
119
|
-
text: "\u53D8\u66F4\u65E5\u5FD7",
|
|
120
|
-
link: "/CHANGELOG.md"
|
|
121
|
-
});
|
|
113
|
+
nav.push({ text: "\u66F4\u65B0\u65E5\u5FD7", link: "/CHANGELOG.md" });
|
|
122
114
|
}
|
|
123
115
|
function setUserConfig(config) {
|
|
124
116
|
const resUserConfig = merge({}, cloneDeep(defaultUserConfig), isUndefined(config) ? {} : config);
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ruan-cat/vitepress-preset-config",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "用于给大多数的vitepress项目提供一个预设的配置文件。",
|
|
5
|
-
"homepage": "https://
|
|
5
|
+
"homepage": "https://vitepress-preset.ruancat6312.top",
|
|
6
6
|
"types": "./src/config.mts",
|
|
7
7
|
"main": "./src/config.mts",
|
|
8
8
|
"dependencies": {
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "@ruan-cat/vitepress-preset-config/config";
|
|
3
3
|
// @ts-ignore
|
|
4
4
|
import { setUserConfig, setGenerateSidebar, addChangelog2doc } from "../../src/config.mts";
|
|
5
|
+
import { description } from "../../package.json";
|
|
5
6
|
|
|
6
7
|
addChangelog2doc({
|
|
7
8
|
target: "./src",
|
|
@@ -13,7 +14,18 @@ addChangelog2doc({
|
|
|
13
14
|
/**
|
|
14
15
|
* 本文档的渲染配置
|
|
15
16
|
*/
|
|
16
|
-
const thisDocUserConfig = setUserConfig(
|
|
17
|
+
const thisDocUserConfig = setUserConfig({
|
|
18
|
+
title: "vitepress预设配置",
|
|
19
|
+
description,
|
|
20
|
+
themeConfig: {
|
|
21
|
+
socialLinks: [
|
|
22
|
+
{
|
|
23
|
+
icon: "github",
|
|
24
|
+
link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/main/packages/vitepress-preset-config",
|
|
25
|
+
},
|
|
26
|
+
],
|
|
27
|
+
},
|
|
28
|
+
});
|
|
17
29
|
// @ts-ignore
|
|
18
30
|
thisDocUserConfig.themeConfig.sidebar = setGenerateSidebar({
|
|
19
31
|
documentRootPath: "./src",
|
package/src/config.mts
CHANGED
|
@@ -66,8 +66,8 @@ export function setGenerateSidebar(options?: VitePressSidebarOptions) {
|
|
|
66
66
|
|
|
67
67
|
/** 默认用户配置 */
|
|
68
68
|
const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
|
|
69
|
-
title: "
|
|
70
|
-
description: "
|
|
69
|
+
title: "请填写有意义的标题",
|
|
70
|
+
description: "请填写有意义的描述",
|
|
71
71
|
|
|
72
72
|
lang: "zh",
|
|
73
73
|
// 暂不需要
|
|
@@ -81,12 +81,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
|
|
|
81
81
|
},
|
|
82
82
|
|
|
83
83
|
// https://vitepress.dev/reference/default-theme-config
|
|
84
|
-
nav: [
|
|
85
|
-
{ text: "首页", link: "/" },
|
|
86
|
-
{ text: "更新日志", link: "/CHANGELOG.md" },
|
|
87
|
-
// TODO: 未来项目结束时，在此补充配置
|
|
88
|
-
// { text: "仓库地址", link: "https://github.com/ruan-cat/vercel-monorepo-test/tree/dev/packages/docs-01-star" },
|
|
89
|
-
],
|
|
84
|
+
nav: [{ text: "首页", link: "/" }],
|
|
90
85
|
|
|
91
86
|
outline: {
|
|
92
87
|
label: "本页目录",
|
|
@@ -99,7 +94,7 @@ const defaultUserConfig: UserConfig<DefaultTheme.Config> = {
|
|
|
99
94
|
socialLinks: [
|
|
100
95
|
{
|
|
101
96
|
icon: "github",
|
|
102
|
-
link: "https://github.com/ruan-cat
|
|
97
|
+
link: "https://github.com/ruan-cat",
|
|
103
98
|
},
|
|
104
99
|
],
|
|
105
100
|
},
|
|
@@ -169,10 +164,7 @@ function handleChangeLog(userConfig: UserConfig<DefaultTheme.Config>) {
|
|
|
169
164
|
throw new Error(` nav 默认提供的导航栏配置为空。不符合默认配置，请检查。 `);
|
|
170
165
|
}
|
|
171
166
|
|
|
172
|
-
nav.push({
|
|
173
|
-
text: "变更日志",
|
|
174
|
-
link: "/CHANGELOG.md",
|
|
175
|
-
});
|
|
167
|
+
nav.push({ text: "更新日志", link: "/CHANGELOG.md" });
|
|
176
168
|
}
|
|
177
169
|
|
|
178
170
|
/** 设置vitepress主配置 */
|