Skip to content

Commit 8461066

Browse files
author
catlog22
committed
fix(docs): resolve VitePress build errors with custom HTML tags
- Fix custom tags (Good, Bad, Before, After, Tip, Note, Warning) in skill docs - Replace placeholder variables with HTML entities to prevent Vue parser errors - Allow manual workflow_dispatch to trigger docs deployment
1 parent cd54c10 commit 8461066

7 files changed

Lines changed: 127 additions & 78 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ jobs:
5353
path: docs/.vitepress/dist
5454

5555
deploy:
56-
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
56+
if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main'
5757
environment:
5858
name: github-pages
5959
url: ${{ steps.deployment.outputs.page_url }}

‎docs/.vitepress/config.ts‎

Lines changed: 76 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,12 @@ export default defineConfig({
7676
}
7777
],
7878

79-
// Sidebar - 按照 Trellis 风格组织
79+
// Sidebar - 优化导航结构，增加二级标题和归类
8080
sidebar: {
8181
'/guide/': [
8282
{
83-
text: 'Guide',
83+
text: '📖 指南',
84+
collapsible: false,
8485
items: [
8586
{ text: 'What is Claude_dms3', link: '/guide/ch01-what-is-claude-dms3' },
8687
{ text: 'Getting Started', link: '/guide/ch02-getting-started' },
@@ -89,11 +90,20 @@ export default defineConfig({
8990
{ text: 'Advanced Tips', link: '/guide/ch05-advanced-tips' },
9091
{ text: 'Best Practices', link: '/guide/ch06-best-practices' }
9192
]
93+
},
94+
{
95+
text: '🚀 快速入口',
96+
collapsible: true,
97+
items: [
98+
{ text: 'Installation', link: '/guide/installation' },
99+
{ text: 'First Workflow', link: '/guide/first-workflow' },
100+
{ text: 'CLI Tools', link: '/guide/cli-tools' }
101+
]
92102
}
93103
],
94104
'/commands/': [
95105
{
96-
text: 'Claude Commands',
106+
text: '🤖 Claude Commands',
97107
collapsible: true,
98108
items: [
99109
{ text: 'Overview', link: '/commands/claude/' },
@@ -107,7 +117,7 @@ export default defineConfig({
107117
]
108118
},
109119
{
110-
text: 'Codex Prompts',
120+
text: '📝 Codex Prompts',
111121
collapsible: true,
112122
items: [
113123
{ text: 'Overview', link: '/commands/codex/' },
@@ -118,7 +128,7 @@ export default defineConfig({
118128
],
119129
'/skills/': [
120130
{
121-
text: 'Claude Skills',
131+
text: '⚡ Claude Skills',
122132
collapsible: true,
123133
items: [
124134
{ text: 'Overview', link: '/skills/claude-index' },
@@ -130,33 +140,49 @@ export default defineConfig({
130140
]
131141
},
132142
{
133-
text: 'Codex Skills',
143+
text: '🔧 Codex Skills',
134144
collapsible: true,
135145
items: [
136146
{ text: 'Overview', link: '/skills/codex-index' },
137147
{ text: 'Lifecycle', link: '/skills/codex-lifecycle' },
138148
{ text: 'Workflow', link: '/skills/codex-workflow' },
139149
{ text: 'Specialized', link: '/skills/codex-specialized' }
140150
]
151+
},
152+
{
153+
text: '🎨 Custom Skills',
154+
collapsible: true,
155+
items: [
156+
{ text: 'Overview', link: '/skills/custom' },
157+
{ text: 'Core Skills', link: '/skills/core-skills' },
158+
{ text: 'Reference', link: '/skills/reference' }
159+
]
141160
}
142161
],
143162
'/features/': [
144163
{
145-
text: 'Core Features',
164+
text: '⚙️ Core Features',
165+
collapsible: false,
146166
items: [
147167
{ text: 'Spec System', link: '/features/spec' },
148168
{ text: 'Memory System', link: '/features/memory' },
149169
{ text: 'CLI Call', link: '/features/cli' },
150170
{ text: 'Dashboard', link: '/features/dashboard' },
151-
{ text: 'CodexLens', link: '/features/codexlens' },
171+
{ text: 'CodexLens', link: '/features/codexlens' }
172+
]
173+
},
174+
{
175+
text: '🔌 Settings',
176+
collapsible: true,
177+
items: [
152178
{ text: 'API Settings', link: '/features/api-settings' },
153179
{ text: 'System Settings', link: '/features/system-settings' }
154180
]
155181
}
156182
],
157183
'/mcp/': [
158184
{
159-
text: 'MCP Tools',
185+
text: '🔗 MCP Tools',
160186
collapsible: true,
161187
items: [
162188
{ text: 'Overview', link: '/mcp/tools' }
@@ -165,7 +191,7 @@ export default defineConfig({
165191
],
166192
'/agents/': [
167193
{
168-
text: 'Agents',
194+
text: '🤖 Agents',
169195
collapsible: true,
170196
items: [
171197
{ text: 'Overview', link: '/agents/' },
@@ -176,12 +202,13 @@ export default defineConfig({
176202
],
177203
'/workflows/': [
178204
{
179-
text: 'Workflow System',
205+
text: '🔄 Workflow System',
180206
collapsible: true,
181207
items: [
182208
{ text: 'Overview', link: '/workflows/' },
183209
{ text: '4-Level System', link: '/workflows/4-level' },
184-
{ text: 'Best Practices', link: '/workflows/best-practices' }
210+
{ text: 'Best Practices', link: '/workflows/best-practices' },
211+
{ text: 'Teams', link: '/workflows/teams' }
185212
]
186213
}
187214
]
@@ -259,7 +286,7 @@ export default defineConfig({
259286
nav: [
260287
{ text: '指南', link: '/zh/guide/ch01-what-is-claude-dms3' },
261288
{ text: '命令', link: '/zh/commands/claude/' },
262-
{ text: '技能', link: '/skills/' },
289+
{ text: '技能', link: '/zh/skills/claude-index' },
263290
{ text: '功能', link: '/zh/features/spec' },
264291
{
265292
text: '语言',
@@ -271,7 +298,8 @@ export default defineConfig({
271298
sidebar: {
272299
'/zh/guide/': [
273300
{
274-
text: '指南',
301+
text: '📖 指南',
302+
collapsible: false,
275303
items: [
276304
{ text: 'Claude_dms3 是什么', link: '/zh/guide/ch01-what-is-claude-dms3' },
277305
{ text: '快速开始', link: '/zh/guide/ch02-getting-started' },
@@ -280,11 +308,20 @@ export default defineConfig({
280308
{ text: '高级技巧', link: '/zh/guide/ch05-advanced-tips' },
281309
{ text: '最佳实践', link: '/zh/guide/ch06-best-practices' }
282310
]
311+
},
312+
{
313+
text: '🚀 快速入口',
314+
collapsible: true,
315+
items: [
316+
{ text: '安装', link: '/zh/guide/installation' },
317+
{ text: '第一个工作流', link: '/zh/guide/first-workflow' },
318+
{ text: 'CLI 工具', link: '/zh/guide/cli-tools' }
319+
]
283320
}
284321
],
285322
'/zh/commands/': [
286323
{
287-
text: 'Claude 命令',
324+
text: '🤖 Claude 命令',
288325
collapsible: true,
289326
items: [
290327
{ text: '概述', link: '/zh/commands/claude/' },
@@ -298,7 +335,7 @@ export default defineConfig({
298335
]
299336
},
300337
{
301-
text: 'Codex Prompts',
338+
text: '📝 Codex Prompts',
302339
collapsible: true,
303340
items: [
304341
{ text: '概述', link: '/zh/commands/codex/' },
@@ -309,7 +346,7 @@ export default defineConfig({
309346
],
310347
'/zh/skills/': [
311348
{
312-
text: 'Claude Skills',
349+
text: '⚡ Claude Skills',
313350
collapsible: true,
314351
items: [
315352
{ text: '概述', link: '/zh/skills/claude-index' },
@@ -321,38 +358,55 @@ export default defineConfig({
321358
]
322359
},
323360
{
324-
text: 'Codex Skills',
361+
text: '🔧 Codex Skills',
325362
collapsible: true,
326363
items: [
327364
{ text: '概述', link: '/zh/skills/codex-index' },
328365
{ text: '生命周期', link: '/zh/skills/codex-lifecycle' },
329366
{ text: '工作流', link: '/zh/skills/codex-workflow' },
330367
{ text: '专项', link: '/zh/skills/codex-specialized' }
331368
]
369+
},
370+
{
371+
text: '🎨 自定义技能',
372+
collapsible: true,
373+
items: [
374+
{ text: '概述', link: '/zh/skills/custom' },
375+
{ text: '核心技能', link: '/zh/skills/core-skills' },
376+
{ text: '参考', link: '/zh/skills/reference' }
377+
]
332378
}
333379
],
334380
'/zh/features/': [
335381
{
336-
text: '核心功能',
382+
text: '⚙️ 核心功能',
383+
collapsible: false,
337384
items: [
338385
{ text: 'Spec 规范系统', link: '/zh/features/spec' },
339386
{ text: 'Memory 记忆系统', link: '/zh/features/memory' },
340387
{ text: 'CLI 调用', link: '/zh/features/cli' },
341388
{ text: 'Dashboard 面板', link: '/zh/features/dashboard' },
342-
{ text: 'CodexLens', link: '/zh/features/codexlens' },
389+
{ text: 'CodexLens', link: '/zh/features/codexlens' }
390+
]
391+
},
392+
{
393+
text: '🔌 设置',
394+
collapsible: true,
395+
items: [
343396
{ text: 'API 设置', link: '/zh/features/api-settings' },
344397
{ text: '系统设置', link: '/zh/features/system-settings' }
345398
]
346399
}
347400
],
348401
'/zh/workflows/': [
349402
{
350-
text: '工作流系统',
403+
text: '🔄 工作流系统',
351404
collapsible: true,
352405
items: [
353406
{ text: '概述', link: '/zh/workflows/' },
354407
{ text: '四级体系', link: '/zh/workflows/4-level' },
355-
{ text: '最佳实践', link: '/zh/workflows/best-practices' }
408+
{ text: '最佳实践', link: '/zh/workflows/best-practices' },
409+
{ text: '团队协作', link: '/zh/workflows/teams' }
356410
]
357411
}
358412
]

‎docs/.vitepress/theme/components/ProfessionalHome.vue‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ const content = {
299299
label: 'npm',
300300
lines: [
301301
{ type: 'comment', text: '# Install CCW globally' },
302-
{ type: 'cmd', text: 'npm install -g @anthropic/claude-code-workflow' },
302+
{ type: 'cmd', text: 'npm install -g claude-code-workflow' },
303303
{ type: 'output', text: 'added 1 package in 3s' },
304304
{ type: 'comment', text: '# Initialize in your project' },
305305
{ type: 'cmd', text: 'ccw init' },
@@ -314,7 +314,7 @@ const content = {
314314
label: 'pnpm',
315315
lines: [
316316
{ type: 'comment', text: '# Install CCW globally' },
317-
{ type: 'cmd', text: 'pnpm add -g @anthropic/claude-code-workflow' },
317+
{ type: 'cmd', text: 'pnpm add -g claude-code-workflow' },
318318
{ type: 'output', text: 'Done in 2.1s' },
319319
{ type: 'comment', text: '# Initialize in your project' },
320320
{ type: 'cmd', text: 'ccw init' },
@@ -372,7 +372,7 @@ const content = {
372372
label: 'npm',
373373
lines: [
374374
{ type: 'comment', text: '# 全局安装 CCW' },
375-
{ type: 'cmd', text: 'npm install -g @anthropic/claude-code-workflow' },
375+
{ type: 'cmd', text: 'npm install -g claude-code-workflow' },
376376
{ type: 'output', text: 'added 1 package in 3s' },
377377
{ type: 'comment', text: '# 在项目中初始化' },
378378
{ type: 'cmd', text: 'ccw init' },
@@ -387,7 +387,7 @@ const content = {
387387
label: 'pnpm',
388388
lines: [
389389
{ type: 'comment', text: '# 全局安装 CCW' },
390-
{ type: 'cmd', text: 'pnpm add -g @anthropic/claude-code-workflow' },
390+
{ type: 'cmd', text: 'pnpm add -g claude-code-workflow' },
391391
{ type: 'output', text: 'Done in 2.1s' },
392392
{ type: 'comment', text: '# 在项目中初始化' },
393393
{ type: 'cmd', text: 'ccw init' },

‎docs/guide/getting-started.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ CCW is a comprehensive development environment that combines:
1919

2020
```bash
2121
# Install CCW globally
22-
npm install -g @ccw/cli
22+
npm install -g claude-code-workflow
2323

2424
# Or use with npx
2525
npx ccw --help
@@ -48,7 +48,7 @@ Create a simple workflow in under 5 minutes:
4848

4949
- [Installation Guide](./installation.md) - Detailed installation instructions
5050
- [First Workflow](./first-workflow.md) - 30-minute quickstart tutorial
51-
- [Configuration](./configuration.md) - Customize your CCW setup
51+
- [CLI Tools](./cli-tools.md) - Customize your CCW setup
5252

5353
::: tip Need Help?
5454
Check out our [GitHub Discussions](https://github.com/your-repo/ccw/discussions) or join our [Discord community](https://discord.gg/ccw).

‎docs/guide/installation.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Before installing CCW, make sure you have:
1515
### Global Installation (Recommended)
1616

1717
```bash
18-
npm install -g @ccw/cli
18+
npm install -g claude-code-workflow
1919
```
2020

2121
### Project-Specific Installation
2222

2323
```bash
2424
# In your project directory
25-
npm install --save-dev @ccw/cli
25+
npm install --save-dev claude-code-workflow
2626

2727
# Run with npx
2828
npx ccw [command]
@@ -32,10 +32,10 @@ npx ccw [command]
3232

3333
```bash
3434
# Global
35-
yarn global add @ccw/cli
35+
yarn global add claude-code-workflow
3636

3737
# Project-specific
38-
yarn add -D @ccw/cli
38+
yarn add -D claude-code-workflow
3939
```
4040

4141
## Verify Installation
@@ -98,16 +98,16 @@ Create `CLAUDE.md` in your project root:
9898

9999
```bash
100100
# Update to the latest version
101-
npm update -g @ccw/cli
101+
npm update -g claude-code-workflow
102102

103103
# Or install a specific version
104-
npm install -g @ccw/cli@latest
104+
npm install -g claude-code-workflow@latest
105105
```
106106

107107
## Uninstallation
108108

109109
```bash
110-
npm uninstall -g @ccw/cli
110+
npm uninstall -g claude-code-workflow
111111

112112
# Remove configuration (optional)
113113
rm -rf ~/.claude
@@ -121,7 +121,7 @@ If you encounter permission errors:
121121

122122
```bash
123123
# Use sudo (not recommended)
124-
sudo npm install -g @ccw/cli
124+
sudo npm install -g claude-code-workflow
125125

126126
# Or fix npm permissions (recommended)
127127
mkdir ~/.npm-global

0 commit comments

Comments
 (0)