快速开始

本指南将帮助您快速搭建和运行 AutoDoc 自动化文档系统。

环境准备

系统要求

  • Node.js: >= 16.0.0
  • npm: >= 7.0.0 或 yarn: >= 1.22.0
  • Git: 用于版本控制

检查环境

# 检查 Node.js 版本
node --version

# 检查 npm 版本
npm --version

# 检查 Git 版本
git --version

安装步骤

1. 克隆项目

git clone https://github.com/your-username/autodoc.git
cd autodoc

2. 安装依赖

npm install

3. 启动开发服务器

npm run docs:dev

启动成功后，访问 http://localhost:8080 查看文档站点。

项目结构说明

AutoDoc/
├── docs/                    # 📁 文档源文件目录
│   ├── .vuepress/          # ⚙️ VuePress 配置目录
│   │   ├── config.js       # 🔧 主配置文件
│   │   ├── public/         # 📂 静态资源目录
│   │   └── styles/         # 🎨 自定义样式
│   ├── README.md           # 🏠 首页文档
│   ├── guide/              # 📖 使用指南
│   ├── api/                # 📋 API 文档
│   ├── automation/         # 🤖 自动化相关文档
│   └── ai/                 # 🧠 AI 助手文档
├── scripts/                # 📜 自动化脚本
├── .github/                # 🔄 GitHub Actions
└── package.json            # 📦 项目配置

基础配置

修改站点信息

编辑 docs/.vuepress/config.js 文件：

export default defineUserConfig({
  lang: 'zh-CN',
  title: '您的项目名称',           // 修改站点标题
  description: '您的项目描述',      // 修改站点描述
  
  theme: defaultTheme({
    navbar: [
      // 配置导航栏
    ],
    sidebar: {
      // 配置侧边栏
    },
  }),
})

自定义首页

编辑 docs/README.md 文件来自定义首页内容。

常用命令

# 开发模式（热重载）
npm run docs:dev

# 构建生产版本
npm run docs:build

# 预览构建结果
npm run docs:serve

# 运行 RPA 更新脚本
npm run rpa:update

# 部署到 GitHub Pages
npm run deploy

下一步

现在您已经成功搭建了基础环境，接下来可以：

  1. 配置详解 - 深入了解各种配置选项
  2. 创建内容 - 学习如何创建和组织文档内容
  3. 自动化设置 - 配置 RPA 和 CI/CD 流程
  4. AI 助手使用 - 使用 AI 辅助编程功能

常见问题

Q: 启动时出现端口占用错误？

A: 可以指定其他端口：

npm run docs:dev -- --port 3000

Q: 如何修改默认主题样式？

A: 在 docs/.vuepress/styles/ 目录下创建自定义样式文件。

Q: 如何添加自定义插件？

A: 在 config.js 的 plugins 数组中添加插件配置。

获取帮助

如果遇到问题，可以：