@hefou/dux 1.0.0 → 1.0.1
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/README.md +39 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,28 @@
|
|
|
1
|
-
# dux
|
|
1
|
+
# @hefou/dux
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<p>
|
|
5
|
+
<img src="https://i.theojs.net/logo/lumen-logo-large.svg" width="300" alt="@hefou/dux" />
|
|
6
|
+
</p>
|
|
7
|
+
<p>
|
|
8
|
+
<img
|
|
9
|
+
src="https://img.shields.io/npm/v/@hefou/dux?style=flat-square&colorA=080f12&colorB=1fa669"
|
|
10
|
+
alt="release"
|
|
11
|
+
/>
|
|
12
|
+
<img
|
|
13
|
+
src="https://img.shields.io/npm/dm/@hefou/dux?style=flat-square&colorA=080f12&colorB=1fa669"
|
|
14
|
+
alt="downloads"
|
|
15
|
+
/>
|
|
16
|
+
<img
|
|
17
|
+
src="https://img.shields.io/npm/l/@hefou/dux?style=flat-square&colorA=080f12&colorB=1fa669"
|
|
18
|
+
alt="license"
|
|
19
|
+
/>
|
|
20
|
+
</p>
|
|
21
|
+
<p>
|
|
22
|
+
<a href="https://hefou.github.io/">演示站点</a> |
|
|
23
|
+
<a href="https://hefou.github.io">查看文档</a>
|
|
24
|
+
</p>
|
|
25
|
+
</div>
|
|
2
26
|
|
|
3
27
|
现代、优雅、可定制的 VitePress 文档主题，适合技术文档与项目站点。
|
|
4
28
|
|
|
@@ -17,10 +41,16 @@
|
|
|
17
41
|
|
|
18
42
|
### 1. 安装主题
|
|
19
43
|
|
|
20
|
-
```
|
|
21
|
-
pnpm add dux
|
|
22
|
-
|
|
23
|
-
|
|
44
|
+
```sh [pnpm]
|
|
45
|
+
pnpm add @hefou/dux
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```sh [npm]
|
|
49
|
+
npm install @hefou/dux
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```sh [yarn]
|
|
53
|
+
yarn add @hefou/dux
|
|
24
54
|
```
|
|
25
55
|
|
|
26
56
|
### 2. 在项目根目录新建 `.npmrc`
|
|
@@ -38,7 +68,7 @@ ignoreBuilds=false
|
|
|
38
68
|
|
|
39
69
|
```ts
|
|
40
70
|
// .vitepress/config.ts
|
|
41
|
-
import { withTheme } from "dux/config";
|
|
71
|
+
import { withTheme } from "@hefou/dux/config";
|
|
42
72
|
|
|
43
73
|
export default withTheme({
|
|
44
74
|
title: "My Docs",
|
|
@@ -51,7 +81,7 @@ export default withTheme({
|
|
|
51
81
|
|
|
52
82
|
```ts
|
|
53
83
|
// .vitepress/theme/index.ts
|
|
54
|
-
import { theme } from "dux";
|
|
84
|
+
import { theme } from "@hefou/dux";
|
|
55
85
|
export default theme;
|
|
56
86
|
```
|
|
57
87
|
|
|
@@ -63,9 +93,9 @@ pnpm vitepress dev docs
|
|
|
63
93
|
## 配置项示例
|
|
64
94
|
|
|
65
95
|
```ts
|
|
66
|
-
export default
|
|
96
|
+
export default VPTheme({
|
|
67
97
|
title: "My Docs",
|
|
68
|
-
description: "基于 @
|
|
98
|
+
description: "基于 @hefou/dux 构建文档站点",
|
|
69
99
|
lang: "zh-CN",
|
|
70
100
|
themeConfig: {
|
|
71
101
|
logo: "/logo.svg",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hefou/dux",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "基于VitePress 文档主题，适配AI知识库与项目文档",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/cjs/index.cjs",
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
},
|
|
78
78
|
"repository": {
|
|
79
79
|
"type": "git",
|
|
80
|
-
"url": "https://
|
|
80
|
+
"url": "https://github.com/hefou/vpt",
|
|
81
81
|
"directory": "packages/dux"
|
|
82
82
|
},
|
|
83
83
|
"scripts": {
|