# hei-docs

**Repository Path**: jiangbyte/hei-docs

## Basic Information

- **Project Name**: hei-docs
- **Description**: Hei Docs 是 HEI 快速开发框架的官方文档站点
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://jiangbyte.github.io/hei-docs/hei-docs/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-02
- **Last Updated**: 2026-05-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hei Docs

<img width="120" src="https://jiangbyte.github.io/hei-docs/logo.svg">

**Hei Docs** 是 HEI 快速开发框架的官方文档站点，基于 VitePress 构建，为整个 HEI 技术体系提供统一、完善的文档支持。

![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
![VitePress](https://img.shields.io/badge/VitePress-1.x-brightgreen.svg)

## 📖 关于本站

Hei Docs 是 HEI 生态的**核心文档基础设施**，收录了 HEI 框架体系所有子项目的完整文档，包括：

- **快速开始**：各项目的介绍、安装和快速上手
- **API 文档**：完整的接口参考和类型定义
- **最佳实践**：架构设计、性能优化、安全指南
- **教程指南**：从零到一的实战教程和案例分析
- **FAQ**：常见问题和解决方案

**在线访问**: [https://jiangbyte.github.io/hei-docs/](https://jiangbyte.github.io/hei-docs/)

## 🏗️ 技术架构

| 类型 | 技术 |
|------|------|
| 构建工具 | VitePress 1.x、Vite 5.x |
| 视图层 | Vue 3.x |
| 内容格式 | Markdown + Vue 组件 |
| 部署平台 | GitHub Pages |

## 📁 文档结构

```
hei-docs/
├── docs/
│   ├── .vitepress/        # VitePress 配置文件
│   ├── index.md           # 文档站首页
│   ├── hei-boot/          # Hei Boot 完整文档
│   ├── hei-cloud/         # Hei Cloud 完整文档
│   ├── hei-admin-vue/     # Hei Admin Vue 完整文档
│   ├── hei-flutter/       # Hei Flutter 完整文档
│   ├── hei-uniapp/        # Hei Uniapp 完整文档
│   ├── hei-goframe/       # Hei Goframe 完整文档
│   ├── hei-fastapi/       # Hei Fastapi 完整文档
│   └── hei-unity/         # Hei Unity 完整文档
├── package.json           # 依赖配置
└── README.md              # 项目说明
```

## 🚀 本地开发

### 前置要求

- Node.js >= 18
- pnpm >= 8（推荐）或 npm >= 9

### 快速启动

```bash
# 1. 安装依赖
pnpm install

# 2. 启动本地开发服务器
pnpm run docs:dev
```

开发服务器启动后，访问终端输出的 URL（通常是 `http://localhost:5173`）即可实时预览文档。

### 构建生产版本

```bash
# 构建静态站点
pnpm run docs:build

# 预览构建结果
pnpm run docs:preview
```

构建产物将输出到 `docs/.vitepress/dist` 目录，可直接部署到任意静态文件服务器。

## ✍️ 文档贡献指南

我们非常欢迎社区参与文档建设，无论是修正错别字、补充示例代码，还是撰写完整的教程，每一份贡献都弥足珍贵。

### 文档规范

1. **目录结构**：每个子项目独立文件夹，按功能模块组织文档
2. **命名规范**：文件名使用小写连字符（kebab-case）
3. **代码示例**：所有代码块必须标注语言，确保可运行
4. **链接规范**：使用相对路径链接站内文档，绝对路径链接站外资源

### 提交流程

1. Fork 本仓库
2. 新建 `docs/xxx` 分支（如 `docs/add-auth-tutorial`）
3. 在对应项目文件夹下修改或新增文档
4. 本地运行 `pnpm run docs:dev` 预览效果
5. 提交代码并创建 Pull Request

### 文档类型

- **使用指南**：功能介绍、配置说明、操作步骤
- **API 参考**：接口定义、参数说明、返回值类型
- **教程案例**：完整的项目实战、最佳实践
- **FAQ**：常见问题排查和解决方案

## 🔗 HEI 生态项目

Hei Docs 是 HEI 技术体系的文档中心，为以下项目提供文档支持：

| 项目 | 简介 | 文档 |
|------|------|------|
| **[Hei Boot](../hei-boot)** | Java 单体应用框架 | [查看文档](./docs/hei-boot/) |
| **[Hei Cloud](../hei-cloud)** | Java 微服务架构 | [查看文档](./docs/hei-cloud/) |
| **[Hei Admin Vue](../hei-admin-vue)** | Vue3 前端管理后台 | [查看文档](./docs/hei-admin-vue/) |

## 📄 开源协议

本项目采用 [MIT License](LICENSE) 开源协议。

## 💬 联系方式

- [Gitee](https://gitee.com/jiangbyte/hei-docs)
- [GitHub](https://github.com/jiangbyte/hei-docs)
- [掘金](https://juejin.cn/user/1968540037686224)

---

> Hei Docs 由社区驱动，持续更新中。如果文档对你有帮助，欢迎给仓库一个 Star ⭐ 支持！