@zjex/git-workflow 0.2.24 → 0.3.0

package/docs/.vitepress/cache/deps_temp_44e2fb0f/vue.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/docs/.vitepress/config.ts

@@ -0,0 +1,167 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'Git Workflow',
+  description: '🚀 极简的 Git 工作流 CLI 工具，让分支管理和版本发布变得轻松愉快',
+  
+  // 基础配置
+  base: '/git-workflow/',
+  lang: 'zh-CN',
+  
+  // 主题配置
+  themeConfig: {
+    // Logo
+    logo: '/logo.svg',
+    
+    // 导航栏
+    nav: [
+      { text: '首页', link: '/' },
+      { text: '快速开始', link: '/guide/getting-started' },
+      { text: '命令参考', link: '/commands/' },
+      { text: '配置', link: '/config/' },
+      { text: 'GitHub', link: 'https://github.com/iamzjt-front-end/git-workflow' }
+    ],
+
+    // 侧边栏
+    sidebar: {
+      '/guide/': [
+        {
+          text: '指南',
+          items: [
+            { text: '介绍', link: '/guide/' },
+            { text: '快速开始', link: '/guide/getting-started' },
+            { text: '安装', link: '/guide/installation' },
+            { text: '基础用法', link: '/guide/basic-usage' },
+            { text: '最佳实践', link: '/guide/best-practices' }
+          ]
+        },
+        {
+          text: '核心功能',
+          items: [
+            { text: 'AI 智能提交', link: '/guide/ai-commit' },
+            { text: '分支管理', link: '/guide/branch-management' },
+            { text: 'Tag 管理', link: '/guide/tag-management' },
+            { text: 'Stash 管理', link: '/guide/stash-management' },
+            { text: '版本发布', link: '/guide/release-management' }
+          ]
+        },
+        {
+          text: '高级用法',
+          items: [
+            { text: '团队协作', link: '/guide/team-collaboration' },
+            { text: '工作流集成', link: '/guide/workflow-integration' },
+            { text: '自动化脚本', link: '/guide/automation' }
+          ]
+        }
+      ],
+      '/commands/': [
+        {
+          text: '命令参考',
+          items: [
+            { text: '概览', link: '/commands/' },
+            { text: '交互式菜单', link: '/commands/interactive' },
+            { text: '分支命令', link: '/commands/branch' },
+            { text: 'Tag 命令', link: '/commands/tag' },
+            { text: '提交命令', link: '/commands/commit' },
+            { text: 'Stash 命令', link: '/commands/stash' },
+            { text: '版本命令', link: '/commands/release' },
+            { text: '配置命令', link: '/commands/config' },
+            { text: '更新命令', link: '/commands/update' },
+            { text: '帮助命令', link: '/commands/help' }
+          ]
+        }
+      ],
+      '/config/': [
+        {
+          text: '配置',
+          items: [
+            { text: '配置概览', link: '/config/' },
+            { text: '配置文件', link: '/config/config-file' },
+            { text: 'AI 配置', link: '/config/ai-config' },
+            { text: '分支配置', link: '/config/branch-config' },
+            { text: '提交配置', link: '/config/commit-config' },
+            { text: '配置示例', link: '/config/examples' }
+          ]
+        }
+      ],
+      '/api/': [
+        {
+          text: 'API 参考',
+          items: [
+            { text: 'CLI API', link: '/api/cli' },
+            { text: '配置 API', link: '/api/config' },
+            { text: '工具函数', link: '/api/utils' }
+          ]
+        }
+      ]
+    },
+
+    // 社交链接
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/iamzjt-front-end/git-workflow' },
+      { icon: 'npm', link: 'https://www.npmjs.com/package/@zjex/git-workflow' }
+    ],
+
+    // 页脚
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2026 zjex'
+    },
+
+    // 搜索
+    search: {
+      provider: 'local'
+    },
+
+    // 编辑链接
+    editLink: {
+      pattern: 'https://github.com/iamzjt-front-end/git-workflow/edit/main/docs/:path',
+      text: '在 GitHub 上编辑此页'
+    },
+
+    // 最后更新时间
+    lastUpdated: {
+      text: '最后更新',
+      formatOptions: {
+        dateStyle: 'short',
+        timeStyle: 'medium'
+      }
+    },
+
+    // 大纲配置
+    outline: {
+      level: [2, 3],
+      label: '页面导航'
+    },
+
+    // 返回顶部
+    returnToTopLabel: '返回顶部',
+
+    // 深色模式切换
+    darkModeSwitchLabel: '主题',
+    lightModeSwitchTitle: '切换到浅色模式',
+    darkModeSwitchTitle: '切换到深色模式'
+  },
+
+  // Markdown 配置
+  markdown: {
+    lineNumbers: true,
+    theme: {
+      light: 'github-light',
+      dark: 'github-dark'
+    }
+  },
+
+  // 头部配置
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/git-workflow/favicon.svg' }],
+    ['link', { rel: 'apple-touch-icon', href: '/git-workflow/logo.svg' }],
+    ['meta', { name: 'theme-color', content: '#646cff' }],
+    ['meta', { name: 'og:type', content: 'website' }],
+    ['meta', { name: 'og:locale', content: 'zh-CN' }],
+    ['meta', { name: 'og:site_name', content: 'Git Workflow' }],
+    ['meta', { name: 'og:image', content: '/git-workflow/logo.svg' }],
+    ['meta', { name: 'og:title', content: 'Git Workflow - 极简的 Git 工作流 CLI 工具' }],
+    ['meta', { name: 'og:description', content: '让分支管理和版本发布变得轻松愉快' }]
+  ]
+})

package/docs/.vitepress/theme/custom.css

@@ -0,0 +1,39 @@
+/* Hero Logo 自适应大小 */
+.VPHero .VPImage {
+  max-width: 320px !important;
+  max-height: 320px !important;
+  margin: 0 auto !important;
+}
+
+.VPHero .VPImage img {
+  max-width: 320px !important;
+  max-height: 320px !important;
+  width: auto !important;
+  height: auto !important;
+  object-fit: contain !important;
+}
+
+/* 响应式设计 - 移动端适配 */
+@media (max-width: 768px) {
+  .VPHero .VPImage {
+    max-width: 200px !important;
+    max-height: 200px !important;
+  }
+
+  .VPHero .VPImage img {
+    max-width: 200px !important;
+    max-height: 200px !important;
+  }
+}
+
+@media (max-width: 480px) {
+  .VPHero .VPImage {
+    max-width: 160px !important;
+    max-height: 160px !important;
+  }
+
+  .VPHero .VPImage img {
+    max-width: 160px !important;
+    max-height: 160px !important;
+  }
+}

package/docs/.vitepress/theme/index.ts

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './custom.css'
+
+export default DefaultTheme

package/docs/README.md

@@ -0,0 +1,82 @@
+# Git Workflow 文档
+
+这是 Git Workflow 的完整文档站点，使用 VitePress 构建。
+
+## 📚 文档结构
+
+### 指南 (`/guide/`)
+- **介绍** - 项目介绍和设计理念
+- **快速开始** - 三步开始使用
+- **安装** - 详细安装说明
+- **基础用法** - 掌握日常操作
+- **AI 智能提交** - 深入了解 AI commit 功能
+- **分支管理** - 高级分支管理技巧
+- **Tag 管理** - 版本标签的高级用法
+- **Stash 管理** - 高效管理代码暂存
+- **版本发布管理** - 自动化版本发布流程
+- **最佳实践** - 学习高效的工作流程
+
+### 命令参考 (`/commands/`)
+- **概览** - 所有命令的概览
+- **交互式菜单** - 主菜单功能详解
+- **分支命令** - 分支管理命令详解
+- **提交命令** - 提交相关命令详解
+
+### 配置文档 (`/config/`)
+- **配置概览** - 配置系统介绍
+- **配置文件详解** - 所有配置项的详细说明
+
+## 🚀 本地开发
+
+### 启动开发服务器
+
+```bash
+npm run docs:dev
+```
+
+然后在浏览器中打开显示的本地地址。
+
+### 构建文档
+
+```bash
+npm run docs:build
+```
+
+### 预览构建结果
+
+```bash
+npm run docs:preview
+```
+
+## 📝 文档特色
+
+- **十分详细的内容** - 涵盖从基础到高级的所有用法
+- **丰富的示例** - 大量实际使用示例和代码片段
+- **清晰的结构** - 按功能模块组织，易于查找
+- **响应式设计** - 支持桌面和移动设备
+- **搜索功能** - 本地搜索，快速找到所需内容
+- **深色主题** - 支持深色/浅色主题切换
+
+## 🎯 内容亮点
+
+1. **完整的功能覆盖** - 每个功能都有详细说明
+2. **实际使用场景** - 提供真实的使用场景和解决方案
+3. **故障排除指南** - 常见问题和解决方案
+4. **最佳实践** - 从个人开发到企业级的最佳实践
+5. **配置详解** - 所有配置项的详细说明和示例
+
+## 📖 如何贡献
+
+1. 在 `docs/` 目录下编辑 Markdown 文件
+2. 使用 `npm run docs:dev` 预览更改
+3. 提交 Pull Request
+
+## 🔗 相关链接
+
+- [GitHub 仓库](https://github.com/iamzjt-front-end/git-workflow)
+- [npm 包](https://www.npmjs.com/package/@zjex/git-workflow)
+- [问题反馈](https://github.com/iamzjt-front-end/git-workflow/issues)
+
+---
+
+这个文档站点为用户提供了完整、详细的 Git Workflow 使用指南，帮助用户快速上手并深入掌握所有功能。