Feat/docs migrate to vitepress #14
Merged
Merged
Conversation
- 将文档首页从传统 Markdown 格式迁移到 VitePress 首页配置 - 添加 VitePress 主题配置文件和自定义样式 - 配置 Git 忽略文件以排除构建产物和依赖 - 添加 VitePress 构建缓存和依赖预构建文件 - 创建 API 示例页面和导航配置 - 移除旧的 TOC 配置文件并替换为新的路由结构
- 将描述从英文改为中文，突出框架的游戏开发定位 - 添加base路径配置以支持GitHub Pages部署 - 重构导航菜单，提供更清晰的文档分类 - 创建详细的侧边栏结构，涵盖入门指南、核心框架、游戏模块等内容 - 更新首页Hero区域，添加框架Logo和现代化功能介绍 - 移除默认示例页面，替换为实际的框架文档 - 添加页脚版权信息和Apache许可证声明 - 创建核心框架、游戏模块和Godot集成的概览文档 - 添加入门指南，包括安装配置、快速开始和架构概览 - 实现完整的多层级文档导航和内容组织
- 重写了 GFramework.Game 模块的完整文档 - 添加了详细的目录结构和使用示例 - 扩展了架构模块系统的说明和代码示例 - 增加了资产管理、存储系统和序列化系统的详细文档 - 提供了模块配置和高级用法的指导 - 完善了存储系统的分层存储和缓存实现 - 添加了序列化系统的自定义转换器示例 - 更新了核心特性和设计理念的描述 - 优化了文档的整体组织结构和可读性 - 刷新了 VitePress 依赖缓存以同步文档变更
- 移除 docfx.json 配置文件 - 移除 filterConfig.yml 过滤配置文件 - 移除 index.md 主页文档 - 移除 toc.yml 导航配置文件 - 移除 API 目录下的 toc.yml 文件
- 移除 architecture 模块的 README 文档 - 移除 command 模块的 README 文档 - 移除 environment 模块的 README 文档 - 移除 events 模块的 README 文档 - 清理框架核心组件的使用说明文档
- 添加 Architecture 包使用说明文档，介绍 MVC 架构模式实现 - 添加 Command 包使用说明文档，阐述命令模式设计和实现 - 添加 Controller 包使用说明文档，描述控制器接口规范 - 添加 Environment 包使用说明文档，定义环境配置功能 - 添加 Events 包使用说明文档，提供事件系统完整介绍
- 在主题配置中添加 logo 属性指向 '/logo-icon.png' - 配置文件中增加 Logo 显示功能
- 替换默认靛蓝色系为GFramework品牌蓝色彩 - 修改首页英雄标题渐变背景为绿色到蓝色到紫色渐变 - 更新首页英雄图像背景为多色透明渐变 - 添加品牌按钮背景渐变样式 - 为功能组件添加悬停阴影效果
- 添加简体中文本地化配置和导航链接 - 配置本地搜索功能并设置中文翻译 - 添加 Catch-all 404 重定向中间件 - 重构侧边栏和导航结构以支持国际化 - 移除旧的英文文档内容并更新配置 - 添加页脚导航和面包屑文字本地化
- 更新VitePress配置移除不必要的服务器中间件 - 实现404页面的中英文国际化显示 - 为404页面添加倒计时自动跳转功能 - 重构404页面样式并添加返回首页按钮 - 优化依赖缓存哈希值更新构建配置
- 创建 NotFound.vue 组件实现404页面功能 - 在主题配置中注册并集成自定义404页面 - 实现中英文双语支持和自动重定向功能 - 添加倒计时自动跳转到首页的功能 - 设计美观的404错误页面样式和布局 - 提供相关文档页面链接建议和返回首页按钮
- 移除 docs/404.md 文件及其所有内容 - 删除 404 页面的 Vue 组件实现代码 - 清理相关样式和脚本配置
- 调整Core模块导航链接结构，从overview页面改为根路径 - 重构Core模块侧边栏，将原有的6个主要类别扩展为15个详细分类 - 精简Game模块侧边栏，保留场景管理和游戏设置两个主要功能 - 更新Godot集成模块侧边栏，新增协程、信号、存储等功能分类 - 修改源码生成器模块命名，将枚举扩展重命名为枚举生成器 - 新增抽象接口侧边栏，包含Core和Game抽象接口文档 - 调整教程模块顺序，新增入门教程和Godot集成教程分类 - 移除独立的API参考导航项，将其整合到相应模块中 - 修正生成器API文档链接路径错误问题
- 修正快速开始页面链接为 /zh-CN/getting-started/quick-start - 修正架构概览页面链接为 /zh-CN/getting-started/architecture-overview - 确保所有中文文档导航链接指向正确的本地化路径
- 修改标题为 GFramework - 更新英雄区域文本描述，强调模块化架构和多引擎集成支持 - 重新组织特性列表，优化清洁架构、CQRS、事件系统、引擎集成、响应式编程和源码生成器的描述 - 调整特性标题和详情内容，使其更准确地反映框架的核心功能 - 修复页面底部布局语法错误
- 将Game和Godot模块的概览链接从overview路径更新为根路径 - 删除了API参考相关的侧边栏导航配置 - 移除了已删除的Game和Godot概览文档文件
- 移除 .NET SDK 相关配置，改为使用 Node.js 环境 - 更新依赖安装方式，使用 npm 替代 dotnet restore - 修改构建命令为 npm run build，替换原有的 DocFX 构建流程 - 调整输出路径配置，从 docfx/_site 改为 docs/.vitepress/dist - 更新工作流触发条件，启用 push 触发器替代手动触发 - 重命名作业名称为 build-and-deploy，简化部署流程 - 更新 Action 版本号，统一使用较新的版本 - [release ci]
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @GeWuYou, your pull request is larger than the review limit of 500000 diff characters
- 移除对所有分支的推送触发器 - 删除通配符标签匹配规则 - 简化工作流权限配置 - 优化工作流触发条件设置 - [release ci]
This was referenced Feb 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.