Skip to content

Dev #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fastapiadmin merged 8 commits into from
May 5, 2026
Merged

Dev #375

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e44f967
feat(docs): 重构文档结构并更新内容
May 1, 2026
e4f7788
feat: 初始化前端项目框架和基础功能
May 1, 2026
b12f7a0
feat(auth): 添加第三方OAuth登录支持
May 2, 2026
bcf16ae
refactor: 删除AgnoSchemaVersions组件及其相关逻辑
May 3, 2026
946497d
feat: 重构前端布局和组件结构
May 4, 2026
6db264b
feat: 删除fastapi-backend.spec文件并更新依赖项注释
May 4, 2026
49ffb9d
feat: 移除系统管理路由并优化路由结构
May 5, 2026
62de577
feat: 更新前端配置和组件样式
May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feat(docs): 重构文档结构并更新内容 
refactor(docs): 迁移文档到src目录并优化配置

style(docs): 统一代码格式和样式

chore(docs): 移除不必要的配置文件和依赖

fix(docs): 修正锁屏对话框的翻译和占位符

feat(components): 添加ElDescriptions组件支持

perf(docs): 优化文档图片加载和缩放功能
  • Loading branch information
zhangtao
zhangtao committed May 1, 2026
commit e44f96740fe7840a43e2db9e264b56dfc17ed6b9
11 changes: 0 additions & 11 deletions frontend/docs/.prettierrc.js
View file
Open in desktop

This file was deleted.

167 changes: 66 additions & 101 deletions frontend/docs/docs/.vitepress/config.ts → frontend/docs/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ import { defineConfig } from 'vitepress'

export default defineConfig({
base: '/',
srcDir: '.',
outDir: '../dist',
// lang: 'zh-CN',
srcDir: 'src',
outDir: './dist',
title: 'FastApiAdmin',
description: '⚡️ 现代、开源、全栈融合的中后台快速开发平台',
ignoreDeadLinks: [
Expand Down Expand Up @@ -64,25 +63,17 @@ export default defineConfig({
{
text: '指南',
items: [
{ text: '项目概述', link: '/overview/' },
{ text: '快速开始', link: '/start/' },
{ text: '为什么选择FastapiAdmin?', link: '/why/' }
]
},
{
text: '开发指南',
items: [
{ text: '前端开发', link: '/frontend/' },
{ text: '后端开发', link: '/backend/' },
{ text: '移动端开发', link: '/miniprogram/' },
{ text: '开发规范', link: '/guidelines/' }
]
},
{
text: '部署与API',
items: [
{ text: '部署指南', link: '/deployment/' },
{ text: 'API文档说明', link: '/api-docs/' },
{ text: '项目概述', link: '/guide/overview' },
{ text: '快速开始', link: '/guide/start' },
{ text: '为什么选择FastapiAdmin?', link: '/guide/why' },
{ text: '前端开发', link: '/guide/frontend' },
{ text: '后端开发', link: '/guide/backend' },
{ text: '移动端开发', link: '/guide/miniprogram' },
{ text: '开发规范', link: '/guide/guidelines' },
{ text: '示例', link: '/guide/examples' },
{ text: '自定义开发', link: '/guide/custom-development' },
{ text: '部署指南', link: '/guide/deployment' },
{ text: 'API文档说明', link: '/guide/api-docs' }
]
},
{
Expand All @@ -93,46 +84,37 @@ export default defineConfig({
{ text: 'V1.0.0', link: 'https://github.com/fastapiadmin/FastapiAdmin/tree/v1.0.0', target: '_blank' }
]
},
{ text: '他们在使用', link: '/users/' },
{ text: '赞助', link: '/sponsor/' },
{ text: '贡献指南', link: '/contributing/' },
{ text: '关于我们', link: '/about/' },
{ text: '他们在使用', link: '/about/users' },
{ text: '赞助', link: '/about/sponsor' },
{ text: '贡献指南', link: '/about/contributing' },
{ text: '关于我们', link: '/about/about' },
],
sidebar: [
{
text: '简介',
collapsed: false,
items: [
{ text: '项目概述', link: '/overview/' },
{ text: '快速开始', link: '/start/' },
{ text: '为什么选择FastapiAdmin?', link: '/why/' }
]
},
{
text: '开发指南',
collapsed: false,
items: [
{ text: '前端开发', link: '/frontend/' },
{ text: '后端开发', link: '/backend/' },
{ text: '移动端开发', link: '/miniprogram/' },
{ text: '开发规范', link: '/guidelines/' }
]
},
{
text: '部署与API',
text: '指南',
collapsed: false,
items: [
{ text: '部署指南', link: '/deployment/' },
{ text: 'API文档说明', link: '/api-docs/' }
{ text: '项目概述', link: '/guide/overview' },
{ text: '快速开始', link: '/guide/start' },
{ text: '为什么选择FastapiAdmin?', link: '/guide/why' },
{ text: '前端开发', link: '/guide/frontend' },
{ text: '后端开发', link: '/guide/backend' },
{ text: '移动端开发', link: '/guide/miniprogram' },
{ text: '开发规范', link: '/guide/guidelines' },
{ text: '示例', link: '/guide/examples' },
{ text: '自定义开发', link: '/guide/custom-development' },
{ text: '部署指南', link: '/guide/deployment' },
{ text: 'API文档说明', link: '/guide/api-docs' }
]
},
{
text: '关于',
items: [
{ text: '他们在使用', link: '/users/' },
{ text: '赞助', link: '/sponsor/' },
{ text: '贡献指南', link: '/contributing/' },
{ text: '关于我们', link: '/about/' },
{ text: '他们在使用', link: '/about/users' },
{ text: '所有用户', link: '/about/users-all' },
{ text: '赞助', link: '/about/sponsor' },
{ text: '贡献指南', link: '/about/contributing' },
{ text: '关于我们', link: '/about/about' },
]
}
],
Expand Down Expand Up @@ -170,25 +152,17 @@ export default defineConfig({
{
text: 'Guide',
items: [
{ text: 'Overview', link: '/en/overview/' },
{ text: 'Quick Start', link: '/en/start/' },
{ text: 'Why FastapiAdmin?', link: '/en/why/' }
]
},
{
text: 'Development',
items: [
{ text: 'Frontend', link: '/en/frontend/' },
{ text: 'Backend', link: '/en/backend/' },
{ text: 'Mini Program', link: '/en/miniprogram/' },
{ text: 'Guidelines', link: '/en/guidelines/' }
]
},
{
text: 'Deployment & API',
items: [
{ text: 'Deployment', link: '/en/deployment/' },
{ text: 'API Docs', link: '/en/api-docs/' },
{ text: 'Overview', link: '/en/guide/overview' },
{ text: 'Quick Start', link: '/en/guide/start' },
{ text: 'Why FastapiAdmin?', link: '/en/guide/why' },
{ text: 'Frontend', link: '/en/guide/frontend' },
{ text: 'Backend', link: '/en/guide/backend' },
{ text: 'Mini Program', link: '/en/guide/miniprogram' },
{ text: 'Guidelines', link: '/en/guide/guidelines' },
{ text: 'Examples', link: '/en/guide/examples' },
{ text: 'Custom Development', link: '/en/guide/custom-development' },
{ text: 'Deployment', link: '/en/guide/deployment' },
{ text: 'API Docs', link: '/en/guide/api-docs' }
]
},
{
Expand All @@ -199,46 +173,37 @@ export default defineConfig({
{ text: 'V1.0.0', link: 'https://github.com/fastapiadmin/FastapiAdmin/tree/v1.0.0', target: '_blank' }
]
},
{ text: 'Who is Using', link: '/en/users/' },
{ text: 'Sponsor', link: '/en/sponsor/' },
{ text: 'Contributing Guide', link: '/en/contributing/' },
{ text: 'About Us', link: '/en/about/' },
{ text: 'Who is Using', link: '/en/about/users' },
{ text: 'Sponsor', link: '/en/about/sponsor' },
{ text: 'Contributing Guide', link: '/en/about/contributing' },
{ text: 'About Us', link: '/en/about/about' },
],
sidebar: [
{
text: 'Introduction',
collapsed: false,
items: [
{ text: 'Overview', link: '/en/overview/' },
{ text: 'Quick Start', link: '/en/start/' },
{ text: 'Why FastapiAdmin?', link: '/en/why/' }
]
},
{
text: 'Development',
collapsed: false,
items: [
{ text: 'Frontend', link: '/en/frontend/' },
{ text: 'Backend', link: '/en/backend/' },
{ text: 'Mini Program', link: '/en/miniprogram/' },
{ text: 'Guidelines', link: '/en/guidelines/' }
]
},
{
text: 'Deployment & API',
text: 'Guide',
collapsed: false,
items: [
{ text: 'Deployment', link: '/en/deployment/' },
{ text: 'API Docs', link: '/en/api-docs/' }
{ text: 'Overview', link: '/en/guide/overview' },
{ text: 'Quick Start', link: '/en/guide/start' },
{ text: 'Why FastapiAdmin?', link: '/en/guide/why' },
{ text: 'Frontend', link: '/en/guide/frontend' },
{ text: 'Backend', link: '/en/guide/backend' },
{ text: 'Mini Program', link: '/en/guide/miniprogram' },
{ text: 'Guidelines', link: '/en/guide/guidelines' },
{ text: 'Examples', link: '/en/guide/examples' },
{ text: 'Custom Development', link: '/en/guide/custom-development' },
{ text: 'Deployment', link: '/en/guide/deployment' },
{ text: 'API Docs', link: '/en/guide/api-docs' }
]
},
{
text: 'About',
items: [
{ text: 'Who is Using', link: '/en/users/' },
{ text: 'Sponsor', link: '/en/sponsor/' },
{ text: 'Contributing Guide', link: '/en/contributing/' },
{ text: 'About Us', link: '/en/about/' },
{ text: 'Who is Using', link: '/en/about/users' },
{ text: 'All Users', link: '/en/about/users-all' },
{ text: 'Sponsor', link: '/en/about/sponsor' },
{ text: 'Contributing Guide', link: '/en/about/contributing' },
{ text: 'About Us', link: '/en/about/about' },
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion frontend/docs/docs/.vitepress/theme/index.ts → frontend/docs/.vitepress/theme/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ export default {
})
})
}
}
}
0 ...tend/docs/docs/.vitepress/theme/style.css → frontend/docs/.vitepress/theme/style.css
View file
Open in desktop
File renamed without changes.
94 changes: 32 additions & 62 deletions frontend/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,50 @@ FastDocs是FastapiAdmin 官网文档，该项目是一套完全开源的快速
## 项目结构

```sh
FastDocs/
FastapiAdmin/frontend/
├─ docs # 源代码
│ ├─ .vitepress # VitePress配置
│ │ ├─ cache/ # 缓存目录
│ │ ├─ theme/ # 主题配置
│ │ │ ├─ index.ts # 主题入口
│ │ │ └─ style.css # 主题样式
│ │ └─ config.ts # 主配置文件
│ ├─ en/ # 英文文档
│ ├─ src/ # 文档源文件
│ │ ├─ guide/ # 指南（所有文档）
│ │ │ ├─ overview.md # 项目概述
│ │ │ ├─ start.md # 快速开始
│ │ │ ├─ why.md # 为什么选择FastapiAdmin
│ │ │ ├─ frontend.md # 前端开发
│ │ │ ├─ backend.md # 后端开发
│ │ │ ├─ miniprogram.md # 移动端开发
│ │ │ ├─ guidelines.md # 开发规范
│ │ │ ├─ examples.md # 示例
│ │ │ ├─ custom-development.md # 自定义开发
│ │ │ ├─ deployment.md # 部署指南
│ │ │ └─ api-docs.md # API文档说明
│ │ ├─ about/ # 关于
│ │ │ └─ index.md # 内容
│ │ ├─ api-docs/ # API文档
│ │ │ └─ index.md # 内容
│ │ ├─ backend/ # 后端文档
│ │ │ └─ index.md # 内容
│ │ ├─ custom-development/ # 自定义开发
│ │ │ └─ index.md # 内容
│ │ ├─ deployment/ # 部署文档
│ │ │ └─ index.md # 内容
│ │ ├─ examples/ # 示例
│ │ │ └─ index.md # 内容
│ │ ├─ frontend/ # 前端文档
│ │ │ └─ index.md # 内容
│ │ ├─ guidelines/ # 指南
│ │ │ └─ index.md # 内容
│ │ ├─ miniprogram/ # 小程序文档
│ │ │ └─ index.md # 内容
│ │ ├─ overview/ # 概览
│ │ │ └─ index.md # 内容
│ │ ├─ start/ # 快速开始
│ │ │ └─ index.md # 内容
│ │ ├─ why/ # 为什么选择
│ │ │ └─ index.md # 内容
│ │ └─ index.md # 英文首页 # 中文文档
│ ├─ about/ # 关于
│ │ └─ index.md # 内容
│ ├─ api-docs/ # API文档
│ │ └─ index.md # 内容
│ ├─ backend/ # 后端文档
│ │ └─ index.md # 内容
│ ├─ custom-development/ # 自定义开发
│ │ └─ index.md # 内容
│ ├─ deployment/ # 部署文档
│ │ └─ index.md # 内容
│ ├─ examples/ # 示例
│ │ └─ index.md # 内容
│ ├─ frontend/ # 前端文档
│ │ └─ index.md # 内容
│ ├─ guidelines/ # 指南
│ │ └─ index.md # 内容
│ ├─ miniprogram/ # 小程序文档
│ │ └─ index.md # 内容
│ ├─ overview/ # 概览
│ │ └─ index.md # 内容
│ ├─ start/ # 快速开始
│ │ └─ index.md # 内容
│ ├─ why/ # 为什么选择
│ │ └─ index.md # 内容
│ ├─ public/ # 公共资源
│ │ ├─ favicon.png
│ │ ├─ group.jpg
│ │ ├─ help.png
│ │ ├─ logo.png
│ │ └─ wechatPay.jpg
│ └─ index.md # 根首页
│ │ │ ├─ about.md # 关于我们
│ │ │ ├─ users.md # 他们在使用
│ │ │ ├─ users-all.md # 所有用户
│ │ │ ├─ sponsor.md # 赞助
│ │ │ └─ contributing.md # 贡献指南
│ │ ├─ en/ # 英文文档（结构同中文）
│ │ │ ├─ guide/
│ │ │ ├─ about/
│ │ │ └─ index.md # 英文首页
│ │ ├─ public/ # 公共资源
│ │ │ ├─ favicon.png
│ │ │ ├─ group.jpg
│ │ │ ├─ help.png
│ │ │ ├─ logo.png
│ │ │ └─ wechatPay.jpg
│ │ └─ index.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配置
└─ tsconfig.json # TypeScript配置

```

Expand All @@ -97,7 +67,7 @@ FastDocs/

```sh
# 进入项目目录
cd FastDocs
cd FastapiAdmin/frontend/docs
# 安装依赖
pnpm install
# 运行文档工程
Expand Down
Loading