# FastDocs

**Repository Path**: fastapiadmin/FastDocs

## Basic Information

- **Project Name**: FastDocs
- **Description**: FastDocs是FastapiAdmin 官网文档，官网工程基于vitepress实现，FastapiAdmin 是一套完全开源的快速开发平台，提供免费使用。它结合了现代、高性能的技术栈，后端采用Fastapi + SQLAlchemy，前端采用基于 vue3 + typescript + vite + pinia + Element-Plus。旨在帮助开发者快速搭建高质量的中后台系统。
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 8
- **Created**: 2025-11-06
- **Last Updated**: 2026-02-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastDocs

FastDocs是FastapiAdmin 官网文档，该项目是一套完全开源的快速开发平台，提供免费使用。它结合了现代、高性能的技术栈，后端采用Fastapi + SQLAlchemy，前端采用基于 vue3 + typescript + vite + pinia + Element-Plus。旨在帮助开发者快速搭建高质量的中后台系统。

## 项目结构

```sh
FastDocs/
├─ docs                 # 源代码
│  ├─ .vitepress           # VitePress配置
│  │  ├─ cache/          # 缓存目录
│  │  ├─ theme/          # 主题配置
│  │  │  ├─ index.ts     # 主题入口
│  │  │  └─ style.css    # 主题样式
│  │  └─ config.ts       # 主配置文件
│  ├─ en/                # 英文文档
│  │  ├─ about.md        # 关于
│  │  ├─ api-docs.md     # API文档
│  │  ├─ backend.md      # 后端文档
│  │  ├─ custom-development.md  # 自定义开发
│  │  ├─ deployment.md   # 部署文档
│  │  ├─ examples.md     # 示例
│  │  ├─ frontend.md     # 前端文档
│  │  ├─ guidelines.md   # 指南
│  │  ├─ index.md        # 英文首页
│  │  ├─ miniprogram.md  # 小程序文档
│  │  ├─ overview.md     # 概览
│  │  ├─ start.md        # 快速开始
│  │  └─ why.md          # 为什么选择
│  ├─ public/            # 公共资源
│  │  ├─ ai.png
│  │  ├─ app_home.png
│  │  ├─ app_login.png
│  │  ├─ app_mine.png
│  │  ├─ dashboard.png
│  │  ├─ favicon.png
│  │  ├─ gencode.png
│  │  ├─ group.jpg
│  │  ├─ logo.png
│  │  └─ wechatPay.jpg
│  ├─ about.md           # 关于
│  ├─ api-docs.md        # API文档
│  ├─ backend.md         # 后端文档
│  ├─ custom-development.md  # 自定义开发
│  ├─ deployment.md      # 部署文档
│  ├─ examples.md        # 示例
│  ├─ frontend.md        # 前端文档
│  ├─ guidelines.md      # 指南
│  ├─ index.md           # 重定向首页
│  ├─ miniprogram.md     # 小程序文档
│  ├─ overview.md        # 概览
│  ├─ start.md           # 快速开始
│  └─ why.md             # 为什么选择
├─ .gitignore            # Git忽略文件
├─ .prettierrc.js        # Prettier配置
├─ LICENSE               # 许可证
├─ README.md             # 项目说明文档
├─ eslint.config.js      # ESLint配置
├─ package.json          # 项目依赖文件
├─ pnpm-lock.yaml        # pnpm锁定文件
├─ tsconfig.json         # TypeScript配置
└─ vite.config.ts        # Vite配置

```

## 🔗 源码仓库

| 平台 | 仓库地址 |
|------|----------|
| GitHub | [FastapiAdmin主工程](https://github.com/fastapiadmin/FastapiAdmin.git) \| [FastDocs官网](https://github.com/fastapiadmin/FastDocs.git) \| [FastApp移动端](https://github.com/fastapiadmin/FastApp.git) |
| Gitee  | [FastapiAdmin主工程](https://gitee.com/fastapiadmin/FastapiAdmin.git) \| [FastDocs官网](https://gitee.com/fastapiadmin/FastDocs.git) \| [FastApp移动端](https://gitee.com/fastapiadmin/FastApp.git) |

## 官网展示

![在线文档](https://gitee.com/fastapiadmin/FastDocs/raw/master/docs/public/help.png)

## 快速开始

```sh
# 进入项目目录
cd FastDocs
# 安装依赖
pnpm install
# 运行文档工程
pnpm run docs:dev
# 构建文档工程
pnpm run docs:build
```