mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
- Introduced comprehensive documentation for the queue management feature, detailing its pain points, core functionalities, and component structure. - Added terminal dashboard documentation, highlighting its layout, core features, and usage examples. - Created an index page in Chinese for Claude Code Workflow, summarizing its purpose and core features, along with quick links to installation and guides.
517 lines
17 KiB
TypeScript
517 lines
17 KiB
TypeScript
import { defineConfig } from 'vitepress'
|
|
import { withMermaid } from 'vitepress-plugin-mermaid'
|
|
import { transformDemoBlocks } from './theme/markdownTransform'
|
|
import path from 'path'
|
|
|
|
const repoName = process.env.GITHUB_REPOSITORY?.split('/')[1]
|
|
const isUserOrOrgSite = Boolean(repoName && repoName.endsWith('.github.io'))
|
|
|
|
const base =
|
|
process.env.CCW_DOCS_BASE ||
|
|
(process.env.GITHUB_ACTIONS && repoName && !isUserOrOrgSite ? `/${repoName}/` : '/')
|
|
|
|
export default withMermaid(defineConfig({
|
|
title: 'Claude Code Workflow Documentation',
|
|
description: 'Claude Code Workspace - Advanced AI-Powered Development Environment',
|
|
lang: 'en-US',
|
|
base,
|
|
|
|
// Ignore dead links for incomplete docs
|
|
ignoreDeadLinks: true,
|
|
head: [
|
|
['link', { rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml' }],
|
|
[
|
|
'script',
|
|
{},
|
|
`(() => {
|
|
try {
|
|
const theme = localStorage.getItem('ccw-theme') || 'blue'
|
|
document.documentElement.setAttribute('data-theme', theme)
|
|
|
|
const mode = localStorage.getItem('ccw-color-mode') || 'auto'
|
|
const prefersDark = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
const isDark = mode === 'dark' || (mode === 'auto' && prefersDark)
|
|
document.documentElement.classList.toggle('dark', isDark)
|
|
} catch {}
|
|
})()`
|
|
],
|
|
['meta', { name: 'theme-color', content: '#3b82f6' }],
|
|
['meta', { name: 'og:type', content: 'website' }],
|
|
['meta', { name: 'og:locale', content: 'en_US' }],
|
|
['meta', { name: 'og:locale:alternate', content: 'zh_CN' }]
|
|
],
|
|
|
|
// Appearance
|
|
appearance: false,
|
|
|
|
// Vite build/dev optimizations
|
|
vite: {
|
|
resolve: {
|
|
alias: {
|
|
'@': path.resolve(__dirname, '../../ccw/frontend/src'),
|
|
'@/components': path.resolve(__dirname, '../../ccw/frontend/src/components'),
|
|
'@/lib': path.resolve(__dirname, '../../ccw/frontend/src/lib')
|
|
}
|
|
},
|
|
optimizeDeps: {
|
|
include: ['flexsearch', 'react', 'react-dom']
|
|
},
|
|
build: {
|
|
target: 'es2019',
|
|
cssCodeSplit: true
|
|
},
|
|
ssr: {
|
|
noExternal: ['react', 'react-dom', 'class-variance-authority', 'clsx', 'tailwind-merge']
|
|
}
|
|
},
|
|
|
|
// Theme configuration
|
|
themeConfig: {
|
|
logo: '/logo.svg',
|
|
|
|
// Right-side table of contents (outline)
|
|
outline: {
|
|
level: [2, 3],
|
|
label: 'On this page'
|
|
},
|
|
|
|
// Navigation - 按照 Trellis 风格组织
|
|
nav: [
|
|
{ text: 'Guide', link: '/guide/ch01-what-is-claude-dms3' },
|
|
{ text: 'Commands', link: '/commands/claude/' },
|
|
{ text: 'Skills', link: '/skills/' },
|
|
{ text: 'Features', link: '/features/spec' }
|
|
],
|
|
|
|
// Sidebar - 优化导航结构,增加二级标题和归类
|
|
sidebar: {
|
|
'/guide/': [
|
|
{
|
|
text: '📖 指南',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'What is Claude Code Workflow', link: '/guide/ch01-what-is-claude-dms3' },
|
|
{ text: 'Getting Started', link: '/guide/ch02-getting-started' },
|
|
{ text: 'Core Concepts', link: '/guide/ch03-core-concepts' },
|
|
{ text: 'Workflow Basics', link: '/guide/ch04-workflow-basics' },
|
|
{ text: 'Advanced Tips', link: '/guide/ch05-advanced-tips' },
|
|
{ text: 'Best Practices', link: '/guide/ch06-best-practices' }
|
|
]
|
|
},
|
|
{
|
|
text: '🚀 快速入口',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Installation', link: '/guide/installation' },
|
|
{ text: 'First Workflow', link: '/guide/first-workflow' },
|
|
{ text: 'CLI Tools', link: '/guide/cli-tools' }
|
|
]
|
|
}
|
|
],
|
|
'/commands/': [
|
|
{
|
|
text: '🤖 Claude Commands',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/commands/claude/' },
|
|
{ text: 'Core Orchestration', link: '/commands/claude/core-orchestration' },
|
|
{ text: 'Workflow', link: '/commands/claude/workflow' },
|
|
{ text: 'Session', link: '/commands/claude/session' },
|
|
{ text: 'Issue', link: '/commands/claude/issue' },
|
|
{ text: 'Memory', link: '/commands/claude/memory' },
|
|
{ text: 'CLI', link: '/commands/claude/cli' },
|
|
{ text: 'UI Design', link: '/commands/claude/ui-design' }
|
|
]
|
|
},
|
|
{
|
|
text: '📝 Codex Prompts',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/commands/codex/' },
|
|
{ text: 'Prep', link: '/commands/codex/prep' },
|
|
{ text: 'Review', link: '/commands/codex/review' }
|
|
]
|
|
}
|
|
],
|
|
'/skills/': [
|
|
{
|
|
text: '⚡ Claude Skills',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/skills/claude-index' },
|
|
{ text: 'Collaboration', link: '/skills/claude-collaboration' },
|
|
{ text: 'Workflow', link: '/skills/claude-workflow' },
|
|
{ text: 'Memory', link: '/skills/claude-memory' },
|
|
{ text: 'Review', link: '/skills/claude-review' },
|
|
{ text: 'Meta', link: '/skills/claude-meta' }
|
|
]
|
|
},
|
|
{
|
|
text: '🔧 Codex Skills',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/skills/codex-index' },
|
|
{ text: 'Lifecycle', link: '/skills/codex-lifecycle' },
|
|
{ text: 'Workflow', link: '/skills/codex-workflow' },
|
|
{ text: 'Specialized', link: '/skills/codex-specialized' }
|
|
]
|
|
},
|
|
{
|
|
text: '🎨 Custom Skills',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/skills/custom' },
|
|
{ text: 'Core Skills', link: '/skills/core-skills' },
|
|
{ text: 'Reference', link: '/skills/reference' }
|
|
]
|
|
}
|
|
],
|
|
'/features/': [
|
|
{
|
|
text: '⚙️ Core Features',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'Spec System', link: '/features/spec' },
|
|
{ text: 'Memory System', link: '/features/memory' },
|
|
{ text: 'CLI Call', link: '/features/cli' },
|
|
{ text: 'Dashboard', link: '/features/dashboard' },
|
|
{ text: 'CodexLens', link: '/features/codexlens' }
|
|
]
|
|
},
|
|
{
|
|
text: '🔌 Settings',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'API Settings', link: '/features/api-settings' },
|
|
{ text: 'System Settings', link: '/features/system-settings' }
|
|
]
|
|
}
|
|
],
|
|
'/components/': [
|
|
{
|
|
text: 'UI Components',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Button', link: '/components/ui/button' },
|
|
{ text: 'Card', link: '/components/ui/card' },
|
|
{ text: 'Input', link: '/components/ui/input' }
|
|
]
|
|
}
|
|
],
|
|
'/mcp/': [
|
|
{
|
|
text: '🔗 MCP Tools',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/mcp/tools' }
|
|
]
|
|
}
|
|
],
|
|
'/agents/': [
|
|
{
|
|
text: '🤖 Agents',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/agents/' },
|
|
{ text: 'Built-in Agents', link: '/agents/builtin' },
|
|
{ text: 'Custom Agents', link: '/agents/custom' }
|
|
]
|
|
}
|
|
],
|
|
'/workflows/': [
|
|
{
|
|
text: '🔄 Workflow System',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Overview', link: '/workflows/' },
|
|
{ text: '4-Level System', link: '/workflows/4-level' },
|
|
{ text: 'Examples', link: '/workflows/examples' },
|
|
{ text: 'Best Practices', link: '/workflows/best-practices' },
|
|
{ text: 'Teams', link: '/workflows/teams' }
|
|
]
|
|
}
|
|
]
|
|
},
|
|
|
|
// Social links
|
|
socialLinks: [
|
|
{ icon: 'github', link: 'https://github.com/catlog22/Claude-Code-Workflow' }
|
|
],
|
|
|
|
// Footer
|
|
footer: {
|
|
message: 'Released under the MIT License.',
|
|
copyright: 'Copyright © 2025-present CCW Contributors'
|
|
},
|
|
|
|
// Edit link
|
|
editLink: {
|
|
pattern: 'https://github.com/catlog22/Claude-Code-Workflow/edit/main/docs/:path',
|
|
text: 'Edit this page on GitHub'
|
|
},
|
|
|
|
// Last updated
|
|
lastUpdated: {
|
|
text: 'Last updated',
|
|
formatOptions: {
|
|
dateStyle: 'full',
|
|
timeStyle: 'short'
|
|
}
|
|
},
|
|
|
|
// Search (handled by custom FlexSearch DocSearch component)
|
|
search: false
|
|
},
|
|
|
|
// Markdown configuration
|
|
markdown: {
|
|
lineNumbers: true,
|
|
theme: {
|
|
light: 'github-light',
|
|
dark: 'github-dark'
|
|
},
|
|
languages: [
|
|
'bash',
|
|
'shell',
|
|
'powershell',
|
|
'json',
|
|
'yaml',
|
|
'toml',
|
|
'javascript',
|
|
'typescript',
|
|
'jsx',
|
|
'tsx',
|
|
'vue',
|
|
'html',
|
|
'css',
|
|
'markdown',
|
|
'python',
|
|
'ruby',
|
|
'diff',
|
|
'xml',
|
|
'mermaid'
|
|
],
|
|
config: (md) => {
|
|
// Add markdown-it plugins if needed
|
|
// Custom demo block transform is handled by markdownTransform.ts
|
|
md.core.ruler.before('block', 'demo-blocks', (state) => {
|
|
const src = state.src
|
|
const transformed = transformDemoBlocks(src, { path: '' })
|
|
if (transformed !== src) {
|
|
state.src = transformed
|
|
}
|
|
})
|
|
}
|
|
},
|
|
|
|
// locales
|
|
locales: {
|
|
root: {
|
|
label: 'English',
|
|
lang: 'en-US'
|
|
},
|
|
zh: {
|
|
label: '简体中文',
|
|
lang: 'zh-CN',
|
|
title: 'Claude Code Workflow 文档',
|
|
description: 'Claude Code Workspace - 高级 AI 驱动开发环境',
|
|
themeConfig: {
|
|
outline: {
|
|
level: [2, 3],
|
|
label: '本页目录'
|
|
},
|
|
nav: [
|
|
{ text: '指南', link: '/zh/guide/ch01-what-is-claude-dms3' },
|
|
{ text: '命令', link: '/zh/commands/claude/' },
|
|
{ text: '技能', link: '/zh/skills/claude-index' },
|
|
{ text: '功能', link: '/zh/features/spec' }
|
|
],
|
|
sidebar: {
|
|
'/zh/guide/': [
|
|
{
|
|
text: '📖 指南',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'Claude Code Workflow 是什么', link: '/zh/guide/ch01-what-is-claude-dms3' },
|
|
{ text: '快速开始', link: '/zh/guide/ch02-getting-started' },
|
|
{ text: '核心概念', link: '/zh/guide/ch03-core-concepts' },
|
|
{ text: '工作流基础', link: '/zh/guide/ch04-workflow-basics' },
|
|
{ text: '高级技巧', link: '/zh/guide/ch05-advanced-tips' },
|
|
{ text: '最佳实践', link: '/zh/guide/ch06-best-practices' }
|
|
]
|
|
},
|
|
{
|
|
text: '🚀 快速入口',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '安装', link: '/zh/guide/installation' },
|
|
{ text: '第一个工作流', link: '/zh/guide/first-workflow' },
|
|
{ text: 'CLI 工具', link: '/zh/guide/cli-tools' }
|
|
]
|
|
}
|
|
],
|
|
'/zh/commands/': [
|
|
{
|
|
text: '🤖 Claude 命令',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/commands/claude/' },
|
|
{ text: '核心编排', link: '/zh/commands/claude/core-orchestration' },
|
|
{ text: '工作流', link: '/zh/commands/claude/workflow' },
|
|
{ text: '会话管理', link: '/zh/commands/claude/session' },
|
|
{ text: 'Issue', link: '/zh/commands/claude/issue' },
|
|
{ text: 'Memory', link: '/zh/commands/claude/memory' },
|
|
{ text: 'CLI', link: '/zh/commands/claude/cli' },
|
|
{ text: 'UI 设计', link: '/zh/commands/claude/ui-design' }
|
|
]
|
|
},
|
|
{
|
|
text: '📝 Codex Prompts',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/commands/codex/' },
|
|
{ text: 'Prep', link: '/zh/commands/codex/prep' },
|
|
{ text: 'Review', link: '/zh/commands/codex/review' }
|
|
]
|
|
}
|
|
],
|
|
'/zh/skills/': [
|
|
{
|
|
text: '⚡ Claude Skills',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/skills/claude-index' },
|
|
{ text: '协作', link: '/zh/skills/claude-collaboration' },
|
|
{ text: '工作流', link: '/zh/skills/claude-workflow' },
|
|
{ text: '记忆', link: '/zh/skills/claude-memory' },
|
|
{ text: '审查', link: '/zh/skills/claude-review' },
|
|
{ text: '元技能', link: '/zh/skills/claude-meta' }
|
|
]
|
|
},
|
|
{
|
|
text: '🔧 Codex Skills',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/skills/codex-index' },
|
|
{ text: '生命周期', link: '/zh/skills/codex-lifecycle' },
|
|
{ text: '工作流', link: '/zh/skills/codex-workflow' },
|
|
{ text: '专项', link: '/zh/skills/codex-specialized' }
|
|
]
|
|
},
|
|
{
|
|
text: '🎨 自定义技能',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/skills/custom' },
|
|
{ text: '核心技能', link: '/zh/skills/core-skills' },
|
|
{ text: '参考', link: '/zh/skills/reference' }
|
|
]
|
|
}
|
|
],
|
|
'/zh/features/': [
|
|
{
|
|
text: '⚙️ 核心功能',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'Spec 规范系统', link: '/zh/features/spec' },
|
|
{ text: 'Memory 记忆系统', link: '/zh/features/memory' },
|
|
{ text: 'CLI 调用', link: '/zh/features/cli' },
|
|
{ text: 'Dashboard 面板', link: '/zh/features/dashboard' },
|
|
{ text: 'CodexLens', link: '/zh/features/codexlens' }
|
|
]
|
|
},
|
|
{
|
|
text: '🔌 设置',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'API 设置', link: '/zh/features/api-settings' },
|
|
{ text: '系统设置', link: '/zh/features/system-settings' }
|
|
]
|
|
}
|
|
],
|
|
'/zh/workflows/': [
|
|
{
|
|
text: '🔄 工作流系统',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '概述', link: '/zh/workflows/' },
|
|
{ text: '四级体系', link: '/zh/workflows/4-level' },
|
|
{ text: '最佳实践', link: '/zh/workflows/best-practices' },
|
|
{ text: '团队协作', link: '/zh/workflows/teams' }
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
'zh-CN': {
|
|
label: '简体中文',
|
|
lang: 'zh-CN',
|
|
title: 'Claude Code Workflow 文档',
|
|
description: 'Claude Code Workspace - 高级 AI 驱动开发环境',
|
|
themeConfig: {
|
|
outline: {
|
|
level: [2, 3],
|
|
label: '本页目录'
|
|
},
|
|
nav: [
|
|
{ text: '指南', link: '/zh-CN/guide/ch01-what-is-claude-dms3' },
|
|
{ text: '命令', link: '/zh-CN/commands/claude/' },
|
|
{ text: '技能', link: '/zh-CN/skills/claude-index' },
|
|
{ text: '功能', link: '/zh-CN/features/spec' },
|
|
{ text: '组件', link: '/zh-CN/components/' }
|
|
],
|
|
sidebar: {
|
|
'/zh-CN/guide/': [
|
|
{
|
|
text: '📖 指南',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'Claude Code Workflow 是什么', link: '/zh-CN/guide/ch01-what-is-claude-dms3' },
|
|
{ text: '快速开始', link: '/zh-CN/guide/ch02-getting-started' },
|
|
{ text: '核心概念', link: '/zh-CN/guide/ch03-core-concepts' },
|
|
{ text: '工作流基础', link: '/zh-CN/guide/ch04-workflow-basics' },
|
|
{ text: '高级技巧', link: '/zh-CN/guide/ch05-advanced-tips' },
|
|
{ text: '最佳实践', link: '/zh-CN/guide/ch06-best-practices' }
|
|
]
|
|
},
|
|
{
|
|
text: '🚀 快速入口',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: '安装', link: '/zh-CN/guide/installation' },
|
|
{ text: '第一个工作流', link: '/zh-CN/guide/first-workflow' },
|
|
{ text: 'CLI 工具', link: '/zh-CN/guide/cli-tools' }
|
|
]
|
|
}
|
|
],
|
|
'/zh-CN/features/': [
|
|
{
|
|
text: '⚙️ 核心功能',
|
|
collapsible: false,
|
|
items: [
|
|
{ text: 'Spec 规范系统', link: '/zh-CN/features/spec' },
|
|
{ text: 'Memory 记忆系统', link: '/zh-CN/features/memory' },
|
|
{ text: 'CLI 调用', link: '/zh-CN/features/cli' },
|
|
{ text: 'Dashboard 面板', link: '/zh-CN/features/dashboard' },
|
|
{ text: 'CodexLens', link: '/zh-CN/features/codexlens' }
|
|
]
|
|
}
|
|
],
|
|
'/zh-CN/components/': [
|
|
{
|
|
text: 'UI 组件',
|
|
collapsible: true,
|
|
items: [
|
|
{ text: 'Button 按钮', link: '/zh-CN/components/ui/button' },
|
|
{ text: 'Card 卡片', link: '/zh-CN/components/ui/card' },
|
|
{ text: 'Input 输入框', link: '/zh-CN/components/ui/input' }
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}))
|