@movk/nuxt-docs 1.1.0 → 1.1.2
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 +24 -28
- package/app/app.vue +1 -1
- package/content.config.ts +2 -2
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -31,36 +31,35 @@
|
|
|
31
31
|
|
|
32
32
|
### 使用模板创建项目
|
|
33
33
|
|
|
34
|
-
```bash
|
|
34
|
+
```bash [Terminal]
|
|
35
35
|
# 使用此模板创建新项目
|
|
36
|
-
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/
|
|
37
|
-
|
|
36
|
+
npx nuxi init -t gh:mhaibaraai/movk-nuxt-docs/templates/default my-docs
|
|
38
37
|
# 进入项目目录
|
|
39
38
|
cd my-docs
|
|
40
|
-
|
|
41
39
|
# 启动开发服务器
|
|
42
40
|
pnpm dev
|
|
43
41
|
```
|
|
42
|
+
访问 `http://localhost:3000` 查看你的文档网站。
|
|
44
43
|
|
|
45
44
|
### 作为 Layer 使用
|
|
46
45
|
|
|
47
46
|
在现有 Nuxt 项目中使用 Movk Nuxt Docs 作为 layer:
|
|
48
47
|
|
|
49
|
-
```bash
|
|
48
|
+
```bash [Terminal]
|
|
50
49
|
# 安装依赖
|
|
51
50
|
pnpm add @movk/nuxt-docs better-sqlite3
|
|
52
51
|
```
|
|
53
52
|
|
|
54
53
|
在 CSS 中导入 Tailwind CSS 和 Nuxt UI
|
|
55
54
|
|
|
56
|
-
```css [
|
|
55
|
+
```css [app/assets/css/main.css]
|
|
57
56
|
@import 'tailwindcss';
|
|
58
57
|
@import '@nuxt/ui';
|
|
59
58
|
```
|
|
60
59
|
|
|
61
60
|
在 `nuxt.config.ts` 中配置:
|
|
62
61
|
|
|
63
|
-
```ts
|
|
62
|
+
```ts [nuxt.config.ts]
|
|
64
63
|
export default defineNuxtConfig({
|
|
65
64
|
extends: ['@movk/nuxt-docs'],
|
|
66
65
|
css: ['~/assets/css/main.css'],
|
|
@@ -80,17 +79,19 @@ export default defineNuxtConfig({
|
|
|
80
79
|
|
|
81
80
|
```bash
|
|
82
81
|
my-docs/
|
|
83
|
-
├── app/
|
|
84
|
-
├──
|
|
85
|
-
│
|
|
86
|
-
|
|
87
|
-
├──
|
|
88
|
-
|
|
89
|
-
├──
|
|
90
|
-
├──
|
|
91
|
-
├── .
|
|
92
|
-
├──
|
|
93
|
-
|
|
82
|
+
├── app/
|
|
83
|
+
│ ├── assets/css/main.css # 全局样式
|
|
84
|
+
│ └── composables/ # 自定义 Composables
|
|
85
|
+
├── content/ # Markdown 内容
|
|
86
|
+
│ ├── index.md # 首页
|
|
87
|
+
│ └── docs/ # 文档页面
|
|
88
|
+
├── public/ # 静态资源
|
|
89
|
+
├── scripts/ # 脚本
|
|
90
|
+
├── nuxt.config.ts # Nuxt 配置
|
|
91
|
+
├── tsconfig.json # TypeScript 配置
|
|
92
|
+
├── package.json # 依赖与脚本
|
|
93
|
+
├── pnpm-workspace.yaml # pnpm 工作区配置
|
|
94
|
+
└── README.md # 项目说明
|
|
94
95
|
```
|
|
95
96
|
|
|
96
97
|
### Monorepo 结构
|
|
@@ -142,13 +143,13 @@ icon: i-lucide-rocket
|
|
|
142
143
|
|
|
143
144
|
### Vercel Analytics
|
|
144
145
|
|
|
145
|
-
```bash
|
|
146
|
+
```bash [Terminal]
|
|
146
147
|
pnpm add @vercel/analytics @vercel/speed-insights
|
|
147
148
|
```
|
|
148
149
|
|
|
149
150
|
创建 `app/plugins/analytics.client.ts`:
|
|
150
151
|
|
|
151
|
-
```typescript
|
|
152
|
+
```typescript [app/plugins/analytics.client.ts]
|
|
152
153
|
import { Analytics } from '@vercel/analytics/nuxt'
|
|
153
154
|
import { SpeedInsights } from '@vercel/speed-insights/nuxt'
|
|
154
155
|
import { createApp, h } from 'vue'
|
|
@@ -189,16 +190,13 @@ export default defineNuxtPlugin({
|
|
|
189
190
|
|
|
190
191
|
### 本地开发
|
|
191
192
|
|
|
192
|
-
```bash
|
|
193
|
+
```bash [Terminal]
|
|
193
194
|
# 克隆项目
|
|
194
195
|
git clone https://github.com/mhaibaraai/movk-nuxt-docs.git
|
|
195
|
-
|
|
196
196
|
# 进入项目目录
|
|
197
197
|
cd movk-nuxt-docs
|
|
198
|
-
|
|
199
198
|
# 安装依赖
|
|
200
199
|
pnpm install
|
|
201
|
-
|
|
202
200
|
# 启动开发服务器
|
|
203
201
|
pnpm dev
|
|
204
202
|
```
|
|
@@ -207,20 +205,18 @@ pnpm dev
|
|
|
207
205
|
|
|
208
206
|
### 构建生产版本
|
|
209
207
|
|
|
210
|
-
```bash
|
|
208
|
+
```bash [Terminal]
|
|
211
209
|
# 构建应用
|
|
212
210
|
pnpm build
|
|
213
|
-
|
|
214
211
|
# 本地预览生产构建
|
|
215
212
|
pnpm preview
|
|
216
213
|
```
|
|
217
214
|
|
|
218
215
|
### 发布
|
|
219
216
|
|
|
220
|
-
```bash
|
|
217
|
+
```bash [Terminal]
|
|
221
218
|
# 发布 layer 到 npm
|
|
222
219
|
pnpm release:layer
|
|
223
|
-
|
|
224
220
|
# 发布完整项目
|
|
225
221
|
pnpm release
|
|
226
222
|
```
|
package/app/app.vue
CHANGED
package/content.config.ts
CHANGED
|
@@ -37,10 +37,10 @@ export default defineContentConfig({
|
|
|
37
37
|
})),
|
|
38
38
|
docs: defineCollection(asSeoCollection({
|
|
39
39
|
type: 'page',
|
|
40
|
-
source: {
|
|
40
|
+
source: [{
|
|
41
41
|
cwd,
|
|
42
42
|
include: 'docs/**/*'
|
|
43
|
-
},
|
|
43
|
+
}],
|
|
44
44
|
schema: z.object({
|
|
45
45
|
links: z.array(Button),
|
|
46
46
|
category: z.string().optional(),
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@movk/nuxt-docs",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.1.
|
|
4
|
+
"version": "1.1.2",
|
|
5
5
|
"private": false,
|
|
6
6
|
"description": "An elegant documentation theme for Nuxt, powered by Nuxt UI and Nuxt Content.",
|
|
7
7
|
"author": "YiXuan <mhaibaraai@gmail.com>",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"README.md"
|
|
28
28
|
],
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@iconify-json/lucide": "^1.2.
|
|
30
|
+
"@iconify-json/lucide": "^1.2.70",
|
|
31
31
|
"@iconify-json/simple-icons": "^1.2.54",
|
|
32
32
|
"@iconify-json/vscode-icons": "^1.2.32",
|
|
33
33
|
"@movk/core": "^0.0.5",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"pathe": "^2.0.3",
|
|
43
43
|
"exsolve": "^1.0.7",
|
|
44
44
|
"git-url-parse": "^16.1.0",
|
|
45
|
-
"motion-v": "^1.7.
|
|
45
|
+
"motion-v": "^1.7.3",
|
|
46
46
|
"nuxt-component-meta": "^0.14.1",
|
|
47
47
|
"prettier": "^3.6.2",
|
|
48
48
|
"nuxt-llms": "^0.1.3",
|