# super-sql-doc

**Repository Path**: guocjsh/super-sql-doc

## Basic Information

- **Project Name**: super-sql-doc
- **Description**: SuperSQL官方文档
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-10
- **Last Updated**: 2026-04-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SuperSQL 文档

这是 SuperSQL 项目的官方文档，使用 VitePress 构建。

## 快速开始

### 安装依赖

```bash
npm install
```

### 启动开发服务器

```bash
npm run docs:dev
```

访问 http://localhost:5173 查看文档。

### 构建生产版本

```bash
npm run docs:build
```

构建后的文件将输出到 `.vitepress/dist` 目录。

### 预览生产构建

```bash
npm run docs:preview
```

## 文档结构

```
docs/
├── .vitepress/          # VitePress 配置和主题
├── guide/               # 指南文档
├── api/                 # API 文档
├── integrations/        # 集成文档
├── models/              # 模型配置
├── examples/            # 示例代码
├── deployment/          # 部署文档
├── faq/                 # 常见问题
├── changelog/           # 更新日志
├── about/               # 关于
├── en/                  # 英文文档
└── index.md             # 首页
```

## 添加新文档

1. 在对应的目录中创建新的 Markdown 文件
2. 在 `.vitepress/config.ts` 中添加导航链接
3. 编写文档内容

## 更新文档

1. 编辑对应的 Markdown 文件
2. 运行 `npm run docs:dev` 预览更改
3. 确认无误后提交更改

## 部署文档

### GitHub Pages

1. 构建文档：`npm run docs:build`
2. 将 `.vitepress/dist` 目录推送到 `gh-pages` 分支
3. 在 GitHub 仓库设置中启用 GitHub Pages

### 其他平台

将 `.vitepress/dist` 目录部署到你选择的静态网站托管平台。

## 技术栈

- **VitePress**: 静态站点生成器
- **Vue 3**: 前端框架
- **TypeScript**: 类型安全
- **自定义主题**: 扩展默认主题

## 许可证

Apache 2.0

## 贡献

欢迎贡献文档改进！请参考 [贡献指南](./about/contributing.md)。