Initial commit: add project files and README
This commit is contained in:
62
README.md
Normal file
62
README.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# XCSDD - API 文档查看器
|
||||
|
||||
基于 React + TypeScript + Vite 构建的 API 文档查看和管理系统。
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **前端框架**: React 18 + TypeScript
|
||||
- **构建工具**: Vite
|
||||
- **样式**: Tailwind CSS
|
||||
- **图标**: Lucide React
|
||||
|
||||
## 功能特性
|
||||
|
||||
- 文档树形导航
|
||||
- API 文档查看
|
||||
- 响应式布局
|
||||
- 美观的 UI 设计
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 安装依赖
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### 开发模式
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### 构建生产版本
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
### 预览构建结果
|
||||
|
||||
```bash
|
||||
npm run preview
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
├── src/
|
||||
│ ├── components/ # React 组件
|
||||
│ ├── docs/ # 文档文件
|
||||
│ ├── lib/ # 工具函数和类型定义
|
||||
│ ├── config.ts # 配置文件
|
||||
│ ├── App.tsx # 主应用组件
|
||||
│ └── main.tsx # 入口文件
|
||||
├── dist/ # 构建输出
|
||||
├── index.html # HTML 入口
|
||||
└── vite.config.ts # Vite 配置
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user