叶动文档中心

欢迎使用叶动文档中心 - 基于 VuePress 的智能文档管理平台，支持自动发现、全文搜索和智能接口文档！

✨ 特性亮点

1. 智能文档发现

  • 自动扫描: 自动扫描 docs/ 目录并生成导航
  • 实时更新: 新增文档自动添加到导航中
  • 层级结构: 支持多级目录组织
  • README 优先: README.md 文件优先显示，其他文件按字母排序

2. 强大的搜索功能

  • 全文搜索: 搜索所有文档内容
  • 实时建议: 输入时智能搜索建议
  • 快捷键: 使用 s 或 / 键快速搜索
  • 结果高亮: 搜索结果高亮显示，便于识别

3. 智能内容管理

高效的文档内容管理：

  • 📝 Markdown 支持 - 完整的 Markdown 语法支持
  • 🎨 主题定制 - 灵活的主题配置和样式定制
  • 🔗 链接管理 - 智能链接检查和管理
  • 📊 内容统计 - 文档内容统计和分析

4. 自动化部署

完整的自动化部署流程：

  • ✅ 文档格式检查
  • 🔗 链接有效性验证
  • 🏗️ 文档自动构建
  • 🚀 GitHub Pages 部署
  • 📢 部署状态通知

📁 项目结构

AutoDoc/
├── 📁 docs/                    # 文档源文件
│   ├── 📁 .vuepress/          # VuePress 配置
│   │   ├── 🔧 config.js       # 主配置文件
│   │   └── 📂 public/         # 静态资源
│   ├── 📁 zh/                 # 中文文档
│   │   ├── 📖 guide/          # 使用指南
│   │   └── 📋 api/            # API 文档
│   └── 📁 en/                 # 英文文档
│       ├── 📖 guide/          # User guide
│       └── 📋 api/            # API documentation
├── 📁 .github/                # GitHub Actions
│   └── 📁 workflows/          # CI/CD 工作流
└── 📦 package.json            # 项目配置

🚀 快速开始

环境要求

  • Node.js 16.0 或更高版本
  • npm 或 yarn 包管理器

安装步骤

# 克隆仓库
git clone https://github.com/your-username/autodoc.git
cd autodoc

# 安装依赖
npm install

# 启动开发服务器
npm run docs:dev

# 访问 http://localhost:8080

基本使用

  1. 添加文档: 在 docs/zh/ 目录下创建 .md 文件
  2. 自动发现: 新文件自动添加到导航中
  3. 预览更改: 开发服务器自动重新加载
  4. 生产构建: 运行 npm run docs:build

📖 文档章节

📖 使用指南

完整的使用文档，涵盖安装、配置和最佳实践。

📋 接口文档

全面的API文档，包含认证指南、使用示例和错误码参考。

🎯 开始使用

建议您按照以下顺序阅读文档：

  1. 快速开始 - 了解基础安装和配置
  2. 配置说明 - 详细的配置选项
  3. 内容创建 - 学习如何创建文档内容
  4. 部署指南 - 部署到生产环境

高级功能

  1. 配置说明 - 详细的配置选项
  2. 部署指南 - 生产环境部署
  3. 内容创建 - 文档编写指南
  4. 接口文档 - API接口文档

🤝 贡献

我们欢迎任何形式的贡献！详见 贡献指南。

📄 许可证

本项目采用 ISC 许可证。

叶动文档中心 - 让文档变得智能高效！🚀