forge_admin/forge-docs

Fusion AI Design 文档

基于 VitePress 的 Fusion AI Design 组件库和框架使用文档。

项目概述

Fusion AI Design 文档站点提供了完整的组件使用指南、API参考、最佳实践和示例代码，帮助开发者快速上手和使用 Fusion AI Design 框架。

文档内容

项目介绍

• 项目概述 - 项目背景、核心特性和设计理念
• 技术栈 - 前端和后端技术栈详解
• 目录结构 - 项目目录结构说明
• 环境配置 - 开发环境配置指南

组件文档

• AI Form 组件库 - 智能表单组件库概述
  • AiForm 表单组件 - 表单组件详细文档
  • AiSearch 搜索组件 - 搜索组件详细文档
  • AiTable 表格组件 - 表格组件详细文档
  • AiCrudPage CRUD页面 - 完整CRUD页面组件文档
• IconSelector 图标选择器 - 图标选择组件文档
• Loading 加载组件 - 加载提示组件文档

布局配置

• 布局配置 - 多种布局模式配置指南
• 主题定制 - 主题颜色和样式定制
• 菜单系统 - 动态菜单和权限控制

工具函数

• 工具函数概述 - 工具函数使用指南
• HTTP请求 - 基于Axios的HTTP工具
• 加密工具 - RSA/AES/DES加密解密工具
• 存储工具 - LocalStorage和SessionStorage封装
• 通用工具 - 日期处理、防抖节流等通用工具

开发指南

本地开发

# 安装依赖
pnpm install

# 启动开发服务器
pnpm docs:dev

# 构建文档
pnpm docs:build

# 预览构建结果
pnpm docs:preview

文档编写规范

1. Markdown格式 - 使用标准Markdown语法编写文档
2. 代码示例 - 提供完整的代码示例和使用场景
3. API文档 - 详细说明每个属性、方法和事件
4. 最佳实践 - 提供实际开发中的最佳实践建议
5. 注意事项 - 标注使用时需要注意的问题

目录结构

fusion_design_docs/
├── .vitepress/          # VitePress配置
├── guide/               # 项目介绍文档
├── components/          # 组件文档
├── layout/              # 布局配置文档
├── utils/               # 工具函数文档
├── public/              # 静态资源
├── index.md             # 首页
└── README.md            # 本文档

贡献指南

欢迎提交Issue和Pull Request来帮助我们改进文档：

1. Fork 项目仓库
2. 创建功能分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启 Pull Request

许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。