跳至主要內容

inNENU 维护介绍

大约 4 分钟约 1247 字

简介

inNENU 小程序、App 的大部分页面都均由 YAML 文件生成。维护者（包括自动化维护的 AI 助手）只需要使用编辑器编辑 YAML，即可增添或修改小程序页面。

YAML

YAML 是专门用来写配置文件的语言，非常简洁和强大，其设计目标，就是方便人类读写。

Schema 与组件

  • 页面结构与所有组件参数的权威定义见 node_modules/innenu-generator/schemas/ 下的 JSON Schema。
  • 人类可读的完整参数表见 小程序简易参数表。
  • 计算机新手（只用 GitHub 网页）修改页面：按 页面修改提示词，把提示词连同页面文件交给任意网页 AI 即可。

维护工作流

  1. 在仓库内维护（有完整项目环境）：直接遵循根目录 CLAUDE.md 开展工作，无需额外提示词。
  2. 计算机小白（只用 GitHub 网页）：跟随 页面修改提示词 的操作指引，把提示词与页面文件一起发给任意网页 AI（豆包 / DeepSeek / ChatGPT 等），再把 AI 返回的完整 YAML 复制回 GitHub 网页保存。

更多参考

所有的小程序页面都在 https://github.com/inNENU/resource/blob/main/pages/ 下，您可以尽情进行参考。

开发注意事项

下面是开发中需要注意的一些问题。

文件命名

由于小程序的访问是通过网址进行的，需要避免中文。页面 YAML 和媒体文件的文件名，请遵守以下命名规则:

  1. 文件名只包含英文与数字和 -，不要包含特殊符号、空格或者中文字符。由多个单词组成的文件名建议使用 - 链接。如 厚普公益学校 可以表示为 hope-good-school。
  2. 尽可能使用简短的单词，必要时可缩写，比如使用 intro desc guide 而不是 introduction description，handbook。
  3. 表达相同或相近内容的多个媒体文件用 "短词组+编号" 的形式即可，不要试图用很长的文字命名。

文本排版

  1. 中文和英文之间最好使用空格隔开
  2. 尽量使用英文的括号

注意高亮

如果您在使用 VSCode 进行编辑，您可能会注意到，数字和布尔值、字符串、对象的键名使用三种不同的颜色进行高亮。

如果您编写的文件出现“红色波浪线”，或您编写的内容的高亮颜色，和其类型不符，那么说明您编写的格式出现了错误。

图片压缩

图片在拍摄需使用 Squoosh 进行压缩。

  • 含有透明区域的图片需要压缩至 Browser PNG 格式
  • Gif 无需压缩
  • 其他图片压缩到 MozJpeg

不含有文字、不需要细节的图片保持 4 万左右分辨率即可，如果图片使用后置摄像机拍摄，即 12 万或 20 万像素，压缩时可酌情考虑 50% 缩放。

文件转码

由于 QQ 小程序对 2003 版本 Office 格式支持极差，即 .doc .xls .ppt。如遇到此类文件，请尝试用 Office 打开，并转换为最新版格式 (docx、xlsx、pptx)。具体方式为 “文件” - “信息” - “转换”。

媒体文件存放（$img 与 $file）

由于 YAML 是纯文本文件，所有的图片、文件等需单独存放于仓库，并在 YAML 中以资源前缀引用，由 innenu-generator 在构建时解析为实际地址：

  • 图片统一存放在仓库 img/ 目录下，页面中用 $img/... 引用，如 src: $img/dorm/photo.jpg
  • 文档等文件统一存放在仓库 file/ 目录下，页面中用 $file/... 引用，如 url: $file/dorm/out.docx
  • img/ 与 file/ 内部均按业务模块分子目录（如 dorm course enroll exam 等），子目录名与 pages/ 下的业务模块对应，文件名遵循「文件命名」规则

AI 助手必读（媒体资源规范）

当页面需要图片或文档资源时，请务必：

  1. 将资源文件保存 / 移动到仓库内对应的 img/ 或 file/ 子目录（目录不存在则按业务模块新建，子目录名与页面所属模块对应）；
  2. 文件名遵循「文件命名」规则（仅英文、数字与 -，简短）；
  3. 在 YAML 中用 $img/子目录/文件名 或 $file/子目录/文件名 引用；
  4. 不要把资源遗留在仓库外或存放在不规范的位置，也不要在页面中引用仓库外部的临时地址或随意构造的绝对网址。

inNENU 服务器文件结构如下:

  • 文件存放在 https://assets.innenu.com/file/ 下 → 用 $file 索引
  • 图片存放在 https://assets.innenu.com/img/ 下 → 用 $img 索引
  • 页面 YAML 存放在 https://res.innenu.com/pages/ 下
  • 图标存放在 https://res.innenu.com/icons/ 下

相关信息

关于完整的服务器文件结构，请访问 https://github.com/inNENU/resource

点位获取

如需获取地理点位，请使用 腾讯地图选点工具。