使用手册

从工程接入到视图结构,按开发顺序使用 Oiyo 的核心能力

这组手册按真实项目的接入顺序编排。先让 Oiyo 接入工程,再配置扫描导入、页面系统和视图结构。

代码示例主要来自脚手架 pnpm create oiyo@latest --preset=standard 创建的最佳实践项目。

代码用于说明功能,不要求你的项目完全照搬目录和业务命名。

阅读路线

第一次接入时,建议按这个顺序走一遍:

1. 工程接入

配置命令、Vite 插件和 TypeScript,让 Oiyo 参与开发和构建流程。

2. 配置系统

oiyo.config.ts 声明框架配置,用 pages.config.ts 声明页面全局配置。

3. 扫描导入

学习 API 和组件如何通过扫描进入生成流程。

4. 路由系统

通过基于文件系统的路由系统,参与 pages.json 构建。

5. 视图结构

用 App.vue 组织应用骨架,用根上下文共享应用级状态,用布局承接页面内容。