Skip to content

Auto VitePress

自动为当前项目生成或更新 VitePress 文档。

功能描述

/auto-vitepress skill 能够智能分析项目结构和 README 内容,自动在 /docs 目录下创建或更新 VitePress 文档网站。

主要功能

  • 自动检测并安装 VitePress 依赖
  • 智能分析项目结构和 README 内容
  • 生成符合项目特色的侧边栏配置
  • 自动创建文档页面
  • 添加 NPM 脚本以方便文档开发和构建

使用场景

  • 新项目需要快速搭建文档网站
  • 现有项目需要添加或更新文档
  • 项目结构发生变化时需要同步更新文档

使用方法

在项目根目录下,在 Claude Code 中输入 /auto-vitepress 即可。

工作流程

该 skill 会自动执行以下步骤:

环境准备

  1. 检查并创建 package.json
  2. 检查并安装 VitePress 和 Vue 依赖
  3. 创建必要的目录结构

智能分析

  1. 读取并分析 README.md 内容
  2. 识别项目的主要功能模块
  3. 根据分析结果构建文档结构

配置生成

  1. 创建或更新 VitePress 配置文件
  2. 生成基于项目特色的侧边栏配置
  3. 添加导航、页脚、最后更新时间等配置

文档生成

  1. 创建首页(基于 README 或项目信息)
  2. 为每个功能模块生成文档页面
  3. 添加 docs:devdocs:build 脚本

启动文档服务器

文档生成完成后,可以使用以下命令:

bash
npm run docs:dev

或构建生产版本:

bash
npm run docs:build

注意事项

  • 生成的文档页面基于 README 和项目分析,可能需要手动调整
  • 配置文件更新时会保留用户自定义配置
  • 建议定期更新文档以保持与项目同步

基于 Apache License 2.0 许可发布