# Oiyo

> Oiyo 是基于 UniApp 的增强型工程框架，提供自动路由、智能布局、根上下文、工程约定与一站式团队服务。

## 文档

Oiyo 的入门指南、使用手册、项目结构、核心概念与 API 参考。

- [介绍](https://oiyo.js.org/docs/guide/overview/introduction): Oiyo 以融合AI协作，提升开发体验，降低心智成本为三大理念
- [安装](https://oiyo.js.org/docs/guide/overview/installation): 通过在线模板导入快速接入体验
- [LLMs.txt](https://oiyo.js.org/docs/guide/agents/llms-txt): 让 AI 工具了解 Oiyo 的使用方法以及最佳实践
- [使用手册](https://oiyo.js.org/docs/manual): 从工程接入到视图结构，按开发顺序使用 Oiyo 的核心能力
- [工程接入](https://oiyo.js.org/docs/manual/engineering): 了解 Oiyo 命令、Vite 插件和 TypeScript 类型入口
- [配置系统](https://oiyo.js.org/docs/manual/configuration): 了解 Oiyo 的框架配置和页面全局配置
- [API 导入](https://oiyo.js.org/docs/manual/scan/api): 让 API 无需手写 import 即可使用
- [组件注册](https://oiyo.js.org/docs/manual/scan/components): 让 Vue 组件无需注册就可以在模板中直接可用
- [页面注册](https://oiyo.js.org/docs/manual/page/register): 基于文件的路由系统，生成主包页面、分包页面、TabBar
- [页面元信息](https://oiyo.js.org/docs/manual/page/meta): 在页面文件中声明标题、布局、页面类型和 TabBar 项
- [全局页面配置](https://oiyo.js.org/docs/manual/page/config): 用 definePagesConfig 维护 pages.json 全局性的页面默认配置
- [页面中间件](https://oiyo.js.org/docs/manual/page/middleware): 在页面进入前执行校验、重定向与导航控制
- [应用骨架](https://oiyo.js.org/docs/manual/shell/app-shell): 在 App.vue 中组织应用外壳、布局入口和页面渲染入口
- [根上下文](https://oiyo.js.org/docs/manual/shell/root-context): 用 defineRootContext 和 useRootContext 共享和使用根状态
- [布局系统](https://oiyo.js.org/docs/manual/shell/layout): 实现页面内容分离与页面外壳
- [网络请求](https://oiyo.js.org/docs/manual/data/http): 使用 http 模块完成请求、上传、下载与统一的响应处理
- [项目结构](https://oiyo.js.org/docs/structure): 了解 Oiyo 应用每一个关键文件的使用和目录的职责
- [.oiyo](https://oiyo.js.org/docs/structure/oiyo): Oiyo 在开发中会调用 .oiyo/ 使框架能力进入类型系统
- [components](https://oiyo.js.org/docs/structure/src/components): 可复用的组件
- [composables](https://oiyo.js.org/docs/structure/src/composables): 可复用的组合式函数
- [layouts](https://oiyo.js.org/docs/structure/src/layouts): 页面公共骨架
- [packages](https://oiyo.js.org/docs/structure/src/packages): 分包约定总目录
- [pages](https://oiyo.js.org/docs/structure/src/pages): 主包页面目录
- [App.vue](https://oiyo.js.org/docs/structure/src/app): 应用根部视图与全局壳层
- [pages.config.ts](https://oiyo.js.org/docs/structure/src/pages-config): 全局 pages.json 配置入口
- [oiyo.config.ts](https://oiyo.js.org/docs/structure/oiyo-config): Oiyo 应用工程级配置
- [package.json](https://oiyo.js.org/docs/structure/package): 依赖、脚本与工作区约定
- [tsconfig.json](https://oiyo.js.org/docs/structure/tsconfig): 类型配置与智能提示
- [根部视图](https://oiyo.js.org/docs/concept/app): 跨页面共享应用级壳层及状态
- [自动路由](https://oiyo.js.org/docs/concept/route): 基于文件系统的页面注册
- [布局系统](https://oiyo.js.org/docs/concept/layout): 使用布局统一页面骨架
- [自动导入](https://oiyo.js.org/docs/concept/auto-imports): 自动收集并注入组件、API 及全局类型声明
- [API 参考](https://oiyo.js.org/docs/api): Oiyo 配置、运行时、宏、组件与 CLI 的权威参考
- [defineOiyoConfig](https://oiyo.js.org/docs/api/config/define-oiyo-config): 声明 Oiyo 工程级约定与扫描目录
- [definePagesConfig](https://oiyo.js.org/docs/api/config/define-pages-config): 声明全局 pages.json 配置（globalStyle/tabBar 等）
- [Vue / UniApp](https://oiyo.js.org/docs/api/runtime/reference): vue 和 uni-app 的导出 API 由 Oiyo 统一收敛提供
- [http](https://oiyo.js.org/docs/api/utils/http): 默认请求实例
- [createHttp](https://oiyo.js.org/docs/api/utils/create-http): 创建带配置的请求实例
- [createHttpAborter](https://oiyo.js.org/docs/api/utils/create-http-aborter): 创建请求中断控制器
- [defineRouteMiddleware](https://oiyo.js.org/docs/api/utils/define-route-middleware): 定义页面导航中间件
- [goTo](https://oiyo.js.org/docs/api/utils/go-to): 创建页面重定向结果
- [abortNavigation](https://oiyo.js.org/docs/api/utils/abort-navigation): 中止当前页面导航
- [defineRootContext](https://oiyo.js.org/docs/api/macro/define-root-context): 在根部视图声明跨页面共享上下文
- [useRootContext](https://oiyo.js.org/docs/api/macro/use-root-context): 使用根部视图声明跨页面共享上下文
- [definePageMeta](https://oiyo.js.org/docs/api/macro/define-page-meta): 在页面内声明元信息（布局/样式/中间件等）
- [<OiyoPage>](https://oiyo.js.org/docs/api/components/oiyo-page): 路由页面插槽，用于渲染当前路由页面
- [<OiyoLayout>](https://oiyo.js.org/docs/api/components/oiyo-layout): 布局渲染入口，用于包裹当前路由页面
- [oiyo prepare](https://oiyo.js.org/docs/api/cli/oiyo-prepare): 同步 Oiyo 项目准备阶段所需内容
- [oiyo dev](https://oiyo.js.org/docs/api/cli/oiyo-dev): 启动指定平台开发服务器
- [oiyo build](https://oiyo.js.org/docs/api/cli/oiyo-build): 构建并产出指定平台的发布包
- [加群互助](https://oiyo.js.org/docs/community/assist): 平权、平等、互爱