跳到主要内容
版本:Next

站点导览

这个站用「原理 → 源码路径 → 工程影响」记录引擎底层机制,不复述官方 API 用法。内容按目录组织,新增一篇文档不需要改任何配置文件。

写作原则​

  • 原理优先:从源码路径推导结论,写清线程边界、生命周期与工程影响,而不是罗列 API 用法。
  • 零配置扩展:分类就是文件夹,顺序由 _category_.json 决定,技术文档的左侧导航树由目录结构自动生成;站点级栏目不进这棵树,见文末「站点信息」。
  • 持续更新:每篇文档的 frontmatter 标明它对应的代码时点,内容变更会进入变更日志并推送给订阅者。

目录约定​

docs/ue/memory/ 内存管理
docs/ue/rendering/ 渲染管线
docs/ue/networking/ 网络同步

关于更新节奏:源码在变,文档会滞后。每篇文档 frontmatter 里的 updated 与版本字段标明了它对应的代码时点;发现结论与当前版本不一致时,请以源码为准,并欢迎提交勘误。

新增一篇文档​

在项目根目录执行(或双击 new-doc.bat):

npm run new -- docs/ue/memory/my-new-doc.md

生成的模板带完整 frontmatter,写好正文后保存即可,本地开发服务器会自动刷新。提交前 CI 会校验 frontmatter、编译 MDX 并检查断链。

从哪篇开始​

站点信息​

以下栏目属于站点本身的维护内容,不是引擎技术分类,因此不出现在左侧技术目录里:

  • 更新日志:按年份分片的文档变更记录,条目规范见同目录的「条目规范」页。
  • 写作规范:内容包结构与可用的渲染能力约定。
  • 上线与维护:打包上线与内容更新的操作手册。