docs: add VitePress documentation site

- Add docs directory with VitePress configuration
- Add GitHub Actions workflow for docs build and deploy
- Support bilingual (English/Chinese) documentation
- Include search, custom theme, and responsive design
This commit is contained in:
catlog22
2026-02-28 16:14:09 +08:00
parent ab65caec45
commit c3ddf7e322
136 changed files with 34486 additions and 0 deletions

View File

@@ -0,0 +1,352 @@
/**
* VitePress Custom Styles
* Overrides and extensions for default VitePress theme
* Design System: ui-ux-pro-max — dark-mode-first, developer-focused
*/
/* ============================================
* Global Theme Variables
* ============================================ */
:root {
--vp-c-brand: var(--vp-c-primary);
--vp-c-brand-light: var(--vp-c-primary-300);
--vp-c-brand-lighter: var(--vp-c-primary-200);
--vp-c-brand-dark: var(--vp-c-primary-700);
--vp-c-brand-darker: var(--vp-c-primary-800);
--vp-home-hero-name-color: var(--vp-c-primary);
--vp-home-hero-name-background: linear-gradient(120deg, var(--vp-c-primary-500) 30%, var(--vp-c-secondary-500));
--vp-button-brand-bg: var(--vp-c-primary);
--vp-button-brand-hover-bg: var(--vp-c-primary-600);
--vp-button-brand-active-bg: var(--vp-c-primary-700);
--vp-custom-block-tip-bg: var(--vp-c-primary-50);
--vp-custom-block-tip-border: var(--vp-c-primary-200);
--vp-custom-block-tip-text: var(--vp-c-primary-700);
--vp-custom-block-warning-bg: var(--vp-c-accent-50);
--vp-custom-block-warning-border: var(--vp-c-accent-200);
--vp-custom-block-warning-text: var(--vp-c-accent-700);
--vp-custom-block-danger-bg: #fef2f2;
--vp-custom-block-danger-border: #fecaca;
--vp-custom-block-danger-text: #b91c1c;
/* Layout Width Adjustments */
--vp-layout-max-width: 1600px;
--vp-content-width: 1000px;
--vp-sidebar-width: 272px;
}
.dark {
--vp-custom-block-tip-bg: rgba(59, 130, 246, 0.1);
--vp-custom-block-tip-border: rgba(59, 130, 246, 0.3);
--vp-custom-block-tip-text: var(--vp-c-primary-300);
--vp-custom-block-warning-bg: rgba(217, 119, 6, 0.1);
--vp-custom-block-warning-border: rgba(217, 119, 6, 0.3);
--vp-custom-block-warning-text: var(--vp-c-accent-300);
--vp-custom-block-danger-bg: rgba(185, 28, 28, 0.1);
--vp-custom-block-danger-border: rgba(185, 28, 28, 0.3);
--vp-custom-block-danger-text: #fca5a5;
}
/* ============================================
* Layout Container Adjustments
* ============================================ */
.VPDoc .content-container {
max-width: var(--vp-content-width);
padding: 0 32px;
}
/* Adjust sidebar and content layout */
.VPDoc {
padding-left: var(--vp-sidebar-width);
}
/* Right side outline (TOC) adjustments */
.VPDocOutline {
padding-left: 24px;
}
.VPDocOutline .outline-link {
font-size: 13px;
line-height: 1.6;
padding: 4px 8px;
}
/* ============================================
* Home Page Override
* ============================================ */
.VPHome {
padding-bottom: 0;
}
.VPHomeHero {
padding: 80px 24px;
background: linear-gradient(180deg, var(--vp-c-bg-soft) 0%, var(--vp-c-bg) 100%);
}
/* ============================================
* Documentation Content Typography
* ============================================ */
.vp-doc h1 {
font-weight: 800;
letter-spacing: -0.02em;
margin-bottom: 1.5rem;
}
.vp-doc h2 {
font-weight: 700;
margin-top: 3rem;
padding-top: 2rem;
letter-spacing: -0.01em;
border-top: 1px solid var(--vp-c-divider);
}
.vp-doc h2:first-of-type {
margin-top: 1.5rem;
border-top: none;
}
.vp-doc h3 {
font-weight: 600;
margin-top: 2.5rem;
}
.vp-doc h4 {
font-weight: 600;
margin-top: 2rem;
}
.vp-doc p {
line-height: 1.8;
margin: 1.25rem 0;
}
.vp-doc ul,
.vp-doc ol {
margin: 1.25rem 0;
padding-left: 1.5rem;
}
.vp-doc li {
line-height: 1.8;
margin: 0.5rem 0;
}
.vp-doc li + li {
margin-top: 0.5rem;
}
/* Better spacing for code blocks in lists */
.vp-doc li > code {
margin: 0 2px;
}
/* ============================================
* Command Reference Specific Styles
* ============================================ */
.vp-doc h3[id^="ccw"],
.vp-doc h3[id^="workflow"],
.vp-doc h3[id^="issue"],
.vp-doc h3[id^="cli"],
.vp-doc h3[id^="memory"] {
scroll-margin-top: 80px;
position: relative;
}
/* Add subtle separator between command sections */
.vp-doc hr {
border: none;
border-top: 1px solid var(--vp-c-divider);
margin: 3rem 0;
}
/* ============================================
* Custom Container Blocks
* ============================================ */
.custom-container {
margin: 20px 0;
padding: 16px 20px;
border-radius: 12px;
border-left: 4px solid;
}
.custom-container.info {
background: var(--vp-c-bg-soft);
border-color: var(--vp-c-primary);
}
.custom-container.success {
background: var(--vp-c-secondary-50);
border-color: var(--vp-c-secondary);
}
.dark .custom-container.success {
background: rgba(16, 185, 129, 0.1);
}
.custom-container.tip {
border-radius: 12px;
}
.custom-container.warning {
border-radius: 12px;
}
.custom-container.danger {
border-radius: 12px;
}
/* ============================================
* Code Block Improvements
* ============================================ */
.vp-code-group {
margin: 20px 0;
border-radius: 12px;
overflow: hidden;
}
.vp-code-group .tabs {
background: var(--vp-c-bg-soft);
border-bottom: 1px solid var(--vp-c-divider);
}
.vp-code-group div[class*='language-'] {
margin: 0;
border-radius: 0;
}
div[class*='language-'] {
border-radius: 12px;
margin: 20px 0;
}
div[class*='language-'] pre {
line-height: 1.65;
}
/* Inline code */
.vp-doc :not(pre) > code {
border-radius: 6px;
padding: 2px 6px;
font-size: 0.875em;
font-weight: 500;
}
/* ============================================
* Table Styling
* ============================================ */
table {
border-collapse: collapse;
width: 100%;
margin: 20px 0;
border-radius: 12px;
overflow: hidden;
}
table th,
table td {
padding: 12px 16px;
border: 1px solid var(--vp-c-divider);
text-align: left;
}
table th {
background: var(--vp-c-bg-soft);
font-weight: 600;
font-size: 0.875rem;
text-transform: uppercase;
letter-spacing: 0.03em;
color: var(--vp-c-text-2);
}
table tr:hover {
background: var(--vp-c-bg-soft);
}
/* ============================================
* Sidebar Polish
* ============================================ */
.VPSidebar .group + .group {
margin-top: 0.5rem;
padding-top: 0.5rem;
border-top: 1px solid var(--vp-c-divider);
}
/* ============================================
* Scrollbar Styling
* ============================================ */
::-webkit-scrollbar {
width: 6px;
height: 6px;
}
::-webkit-scrollbar-track {
background: transparent;
}
::-webkit-scrollbar-thumb {
background: var(--vp-c-surface-2);
border-radius: var(--vp-radius-full);
}
::-webkit-scrollbar-thumb:hover {
background: var(--vp-c-surface-3);
}
/* ============================================
* Link Improvements
* ============================================ */
a {
text-decoration: none;
transition: color 0.2s ease;
}
a:hover {
text-decoration: underline;
}
/* ============================================
* Focus States — Accessibility
* ============================================ */
:focus-visible {
outline: 2px solid var(--vp-c-primary);
outline-offset: 2px;
}
/* ============================================
* Skip Link — Accessibility
* ============================================ */
.skip-link {
position: absolute;
top: -100px;
left: 0;
background: var(--vp-c-bg);
padding: 8px 16px;
z-index: 9999;
transition: top 0.3s;
}
.skip-link:focus {
top: 0;
}
/* ============================================
* Print Styles
* ============================================ */
@media print {
.VPNav,
.VPSidebar,
.skip-link {
display: none;
}
.VPContent {
margin: 0 !important;
padding: 0 !important;
}
}

View File

@@ -0,0 +1,346 @@
/**
* Mobile-Responsive Styles
* Breakpoints: 320px-768px (mobile), 768px-1024px (tablet), 1024px+ (desktop)
* WCAG 2.1 AA compliant
*/
/* ============================================
* Mobile First Approach
* ============================================ */
/* Base Mobile Styles (320px+) */
@media (max-width: 768px) {
/* Typography */
:root {
--vp-font-size-base: 14px;
--vp-content-width: 100%;
}
/* Container */
.container {
padding: 0 16px;
}
/* Navigation */
.VPNav {
height: 56px;
}
.VPNavBar {
padding: 0 16px;
}
/* Sidebar */
.VPSidebar {
width: 100%;
max-width: 320px;
}
/* Content */
.VPContent {
padding: 16px;
}
/* Doc content adjustments */
.VPDoc .content-container {
padding: 0 16px;
}
/* Hide outline on mobile */
.VPDocOutline {
display: none;
}
/* Hero Section */
.VPHomeHero {
padding: 40px 16px;
}
.VPHomeHero h1 {
font-size: 28px;
line-height: 1.2;
}
.VPHomeHero p {
font-size: 14px;
}
/* Code Blocks */
div[class*='language-'] {
margin: 12px -16px;
border-radius: 0;
}
div[class*='language-'] pre {
padding: 12px 16px;
font-size: 12px;
}
/* Tables - make them scrollable */
.vp-doc table {
display: block;
width: 100%;
overflow-x: auto;
-webkit-overflow-scrolling: touch;
}
table {
font-size: 12px;
}
table th,
table td {
padding: 8px 12px;
}
/* Buttons */
.VPButton {
padding: 8px 16px;
font-size: 14px;
}
/* Cards */
.VPFeature {
padding: 16px;
}
/* Touch-friendly tap targets (min 44x44px per WCAG) */
button,
a,
input,
select,
textarea {
min-height: 44px;
min-width: 44px;
}
/* Search */
.DocSearch {
width: 100%;
}
/* Theme Switcher */
.theme-switcher {
padding: 12px;
}
/* Breadcrumbs */
.breadcrumb {
padding: 8px 0;
font-size: 12px;
}
/* Table of Contents - hidden on mobile */
.page-toc {
display: none;
}
/* Typography adjustments for mobile */
.vp-doc h1 {
font-size: 1.75rem;
margin-bottom: 1rem;
}
.vp-doc h2 {
font-size: 1.375rem;
margin-top: 2rem;
padding-top: 1.5rem;
}
.vp-doc h3 {
font-size: 1.125rem;
margin-top: 1.5rem;
}
.vp-doc p {
line-height: 1.7;
margin: 1rem 0;
}
.vp-doc ul,
.vp-doc ol {
margin: 1rem 0;
padding-left: 1.25rem;
}
.vp-doc li {
margin: 0.375rem 0;
}
}
/* ============================================
* Tablet Styles (768px - 1024px)
* ============================================ */
@media (min-width: 768px) and (max-width: 1024px) {
:root {
--vp-content-width: 760px;
--vp-sidebar-width: 240px;
}
.VPContent {
padding: 24px;
}
.VPDoc .content-container {
padding: 0 24px;
max-width: var(--vp-content-width);
}
.VPHomeHero {
padding: 60px 24px;
}
.VPHomeHero h1 {
font-size: 36px;
}
div[class*='language-'] {
margin: 12px 0;
}
/* Outline visible but narrower */
.VPDocOutline {
width: 200px;
padding-left: 16px;
}
.VPDocOutline .outline-link {
font-size: 12px;
}
}
/* ============================================
* Desktop Styles (1024px+)
* ============================================ */
@media (min-width: 1024px) {
:root {
--vp-layout-max-width: 1600px;
--vp-content-width: 960px;
--vp-sidebar-width: 272px;
}
.VPContent {
padding: 32px 48px;
max-width: var(--vp-layout-max-width);
}
.VPDoc .content-container {
max-width: var(--vp-content-width);
padding: 0 40px;
}
/* Outline - sticky on desktop with good width */
.VPDocOutline {
position: sticky;
top: calc(var(--vp-nav-height) + 24px);
width: 256px;
padding-left: 24px;
max-height: calc(100vh - var(--vp-nav-height) - 48px);
overflow-y: auto;
}
.VPDocOutline .outline-marker {
display: block;
}
.VPDocOutline .outline-link {
font-size: 13px;
line-height: 1.6;
padding: 4px 12px;
transition: color 0.2s ease;
}
.VPDocOutline .outline-link:hover {
color: var(--vp-c-primary);
}
/* Two-column layout for content + TOC */
.content-with-toc {
display: grid;
grid-template-columns: 1fr 280px;
gap: 32px;
}
}
/* ============================================
* Large Desktop (1440px+)
* ============================================ */
@media (min-width: 1440px) {
:root {
--vp-content-width: 1040px;
--vp-sidebar-width: 280px;
}
.VPDoc .content-container {
padding: 0 48px;
}
.VPDocOutline {
width: 280px;
}
}
/* ============================================
* Landscape Orientation
* ============================================ */
@media (max-height: 500px) and (orientation: landscape) {
.VPNav {
height: 48px;
}
.VPHomeHero {
padding: 20px 16px;
}
}
/* ============================================
* High DPI Displays
* ============================================ */
@media (-webkit-min-device-pixel-ratio: 2),
(min-resolution: 192dpi) {
/* Optimize images for retina displays */
img {
image-rendering: -webkit-optimize-contrast;
image-rendering: crisp-edges;
}
}
/* ============================================
* Reduced Motion (Accessibility)
* ============================================ */
@media (prefers-reduced-motion: reduce) {
*,
*::before,
*::after {
animation-duration: 0.01ms !important;
animation-iteration-count: 1 !important;
transition-duration: 0.01ms !important;
}
}
/* ============================================
* Dark Mode Specific
* ============================================ */
@media (max-width: 768px) {
.dark {
--vp-c-bg: #0f172a;
--vp-c-text-1: #f1f5f9;
}
}
/* ============================================
* Print Styles for Mobile
* ============================================ */
@media print and (max-width: 768px) {
.VPContent {
font-size: 10pt;
}
h1 {
font-size: 14pt;
}
h2 {
font-size: 12pt;
}
}

View File

@@ -0,0 +1,221 @@
/**
* Design Tokens for CCW Documentation
* Based on ui-ux-pro-max design system
* 8 themes: 4 colors × 2 modes (light/dark)
*/
:root {
/* ============================================
* Color Scheme: Blue (Default)
* ============================================ */
/* Primary Colors */
--vp-c-primary-50: #eff6ff;
--vp-c-primary-100: #dbeafe;
--vp-c-primary-200: #bfdbfe;
--vp-c-primary-300: #93c5fd;
--vp-c-primary-400: #60a5fa;
--vp-c-primary-500: #3b82f6;
--vp-c-primary-600: #2563eb;
--vp-c-primary-700: #1d4ed8;
--vp-c-primary-800: #1e40af;
--vp-c-primary-900: #1e3a8a;
--vp-c-primary: var(--vp-c-primary-500);
--vp-c-brand-1: var(--vp-c-primary-500);
--vp-c-brand-2: var(--vp-c-secondary-500);
--vp-c-brand-soft: rgba(59, 130, 246, 0.1);
/* Secondary Colors (Green) */
--vp-c-secondary-50: #ecfdf5;
--vp-c-secondary-100: #d1fae5;
--vp-c-secondary-200: #a7f3d0;
--vp-c-secondary-300: #6ee7b7;
--vp-c-secondary-400: #34d399;
--vp-c-secondary-500: #10b981;
--vp-c-secondary-600: #059669;
--vp-c-secondary-700: #047857;
--vp-c-secondary-800: #065f46;
--vp-c-secondary-900: #064e3b;
--vp-c-secondary: var(--vp-c-secondary-500);
/* Accent Colors */
--vp-c-accent-50: #fef3c7;
--vp-c-accent-100: #fde68a;
--vp-c-accent-200: #fcd34d;
--vp-c-accent-300: #fbbf24;
--vp-c-accent-400: #f59e0b;
--vp-c-accent-500: #d97706;
--vp-c-accent: var(--vp-c-accent-400);
/* Background Colors (Light Mode) */
--vp-c-bg: #ffffff;
--vp-c-bg-soft: #f9fafb;
--vp-c-bg-mute: #f3f4f6;
--vp-c-bg-alt: #ffffff;
/* Surface Colors */
--vp-c-surface: #f9fafb;
--vp-c-surface-1: #f3f4f6;
--vp-c-surface-2: #e5e7eb;
--vp-c-surface-3: #d1d5db;
/* Border Colors */
--vp-c-border: #e5e7eb;
--vp-c-border-soft: #f3f4f6;
--vp-c-divider: #e5e7eb;
/* Text Colors */
--vp-c-text-1: #111827;
--vp-c-text-2: #374151;
--vp-c-text-3: #6b7280;
--vp-c-text-4: #9ca3af;
--vp-c-text-code: #ef4444;
/* Typography */
--vp-font-family-base: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
--vp-font-family-mono: 'Fira Code', 'Cascadia Code', 'JetBrains Mono', Consolas, 'Courier New', monospace;
/* Font Sizes */
--vp-font-size-base: 16px;
--vp-font-size-sm: 14px;
--vp-font-size-lg: 18px;
--vp-font-size-xl: 20px;
/* Spacing */
--vp-spacing-xs: 0.25rem; /* 4px */
--vp-spacing-sm: 0.5rem; /* 8px */
--vp-spacing-md: 1rem; /* 16px */
--vp-spacing-lg: 1.5rem; /* 24px */
--vp-spacing-xl: 2rem; /* 32px */
--vp-spacing-2xl: 3rem; /* 48px */
/* Border Radius */
--vp-radius-sm: 0.25rem; /* 4px */
--vp-radius-md: 0.375rem; /* 6px */
--vp-radius-lg: 0.5rem; /* 8px */
--vp-radius-xl: 0.75rem; /* 12px */
--vp-radius-full: 9999px;
/* Shadows */
--vp-shadow-sm: 0 1px 2px 0 rgb(0 0 0 / 0.05);
--vp-shadow-md: 0 4px 6px -1px rgb(0 0 0 / 0.1);
--vp-shadow-lg: 0 10px 15px -3px rgb(0 0 0 / 0.1);
--vp-shadow-xl: 0 20px 25px -5px rgb(0 0 0 / 0.1);
/* Transitions */
--vp-transition-color: 0.2s ease;
--vp-transition-transform: 0.2s ease;
--vp-transition-all: 0.3s cubic-bezier(0.4, 0, 0.2, 1);
/* Z-Index */
--vp-z-index-base: 1;
--vp-z-index-dropdown: 10;
--vp-z-index-sticky: 20;
--vp-z-index-fixed: 50;
--vp-z-index-modal: 100;
--vp-z-index-toast: 200;
}
/* ============================================
* Dark Mode
* ============================================ */
.dark {
/* Background Colors (Dark Mode) */
--vp-c-bg: #111827;
--vp-c-bg-soft: #1f2937;
--vp-c-bg-mute: #374151;
--vp-c-bg-alt: #0f172a;
/* Surface Colors */
--vp-c-surface: #1f2937;
--vp-c-surface-1: #374151;
--vp-c-surface-2: #4b5563;
--vp-c-surface-3: #6b7280;
/* Border Colors */
--vp-c-border: #374151;
--vp-c-border-soft: #1f2937;
--vp-c-divider: #374151;
/* Text Colors */
--vp-c-text-1: #f9fafb;
--vp-c-text-2: #e5e7eb;
--vp-c-text-3: #d1d5db;
--vp-c-text-4: #9ca3af;
--vp-c-text-code: #fca5a5;
/* Primary Colors (adjusted for dark mode) */
--vp-c-primary-50: #1e3a8a;
--vp-c-primary-100: #1e40af;
--vp-c-primary-200: #1d4ed8;
--vp-c-primary-300: #2563eb;
--vp-c-primary-400: #3b82f6;
--vp-c-primary-500: #60a5fa;
--vp-c-primary-600: #93c5fd;
--vp-c-primary-700: #bfdbfe;
--vp-c-primary-800: #dbeafe;
--vp-c-primary-900: #eff6ff;
--vp-c-primary: var(--vp-c-primary-400);
--vp-c-brand-1: var(--vp-c-primary-400);
--vp-c-brand-2: var(--vp-c-secondary-400);
--vp-c-brand-soft: rgba(96, 165, 250, 0.2);
/* Secondary Colors (adjusted for dark mode) */
--vp-c-secondary-50: #064e3b;
--vp-c-secondary-100: #065f46;
--vp-c-secondary-200: #047857;
--vp-c-secondary-300: #059669;
--vp-c-secondary-400: #10b981;
--vp-c-secondary-500: #34d399;
--vp-c-secondary-600: #6ee7b7;
--vp-c-secondary-700: #a7f3d0;
--vp-c-secondary-800: #d1fae5;
--vp-c-secondary-900: #ecfdf5;
--vp-c-secondary: var(--vp-c-secondary-400);
}
/* ============================================
* Color Scheme: Green
* ============================================ */
[data-theme="green"] {
--vp-c-primary: var(--vp-c-secondary-500);
}
[data-theme="green"].dark {
--vp-c-primary: var(--vp-c-secondary-400);
}
/* ============================================
* Color Scheme: Orange
* ============================================ */
[data-theme="orange"] {
--vp-c-primary: var(--vp-c-accent-500);
}
[data-theme="orange"].dark {
--vp-c-primary: var(--vp-c-accent-400);
}
/* ============================================
* Color Scheme: Purple
* ============================================ */
[data-theme="purple"] {
--vp-c-primary-500: #8b5cf6;
--vp-c-primary-600: #7c3aed;
--vp-c-primary-700: #6d28d9;
--vp-c-primary: var(--vp-c-primary-500);
}
[data-theme="purple"].dark {
--vp-c-primary-400: #a78bfa;
--vp-c-primary-500: #8b5cf6;
--vp-c-primary: var(--vp-c-primary-400);
}
/* ============================================
* Utility Classes
* ============================================ */
.text-primary { color: var(--vp-c-primary); }
.text-secondary { color: var(--vp-c-secondary); }
.bg-surface { background-color: var(--vp-c-surface); }
.border-primary { border-color: var(--vp-c-primary); }
.rounded-md { border-radius: var(--vp-radius-md); }
.shadow-md { box-shadow: var(--vp-shadow-md); }
.transition { transition: var(--vp-transition-all); }