跳转到内容

LayaAir 新版文档系统上线公告

各位 LayaAir 开发者:

为了让大家更高效地查找、阅读和使用引擎文档,我们近期对 LayaAir 文档站进行了全面重构。新版文档系统现已上线,原有文档内容也已完成迁移与整理。

这次升级不只是页面样式的调整,而是对文档结构、阅读体验、内容维护方式和发布流程的一次整体更新。

随着 LayaAir 功能不断增加,旧版文档系统逐渐暴露出一些问题,例如目录层级较多、部分内容不易查找、不同版本之间不容易区分,以及复杂示例和多媒体内容的展示能力有限。

新版文档系统基于 Astro 与 Starlight 重新构建,在保留原有文档内容的基础上,重新整理了导航结构,并增强了搜索、版本切换、移动端阅读和交互内容展示等能力。

新版文档提供了更完整的站内全文搜索,可以直接搜索功能名称、组件、API 概念和常见问题,更快定位到相关章节,而不必逐层翻找目录。

文档顶部提供版本切换入口,可以在不同 LayaAir 版本的文档之间快速切换。建议大家在查阅文档时选择与当前项目所用引擎相对应的版本,避免因版本差异导致接口或操作方式不一致。

新版站点支持明暗主题、字体与字号调整、侧栏折叠以及移动端适配。图片支持点击放大,表格、代码块、提示信息和页内导航也进行了统一优化。

页面切换采用无刷新导航,在保持浏览位置和目录状态的同时,缩短页面跳转等待时间。

前后对比图 · 深色主题 前后对比图 · 浅色主题 浅色主题 深色主题

新文档系统支持 Markdown 与 MDX。除了普通文字、图片和代码示例外,文档作者还可以直接加入:

  • 优化前后的图片对比组件;
  • 本地视频、B 站及 YouTube 视频;
  • 可运行的 LayaAir 网页项目和交互示例;
  • 功能对照表、提示横幅和状态说明;
  • 卡片、步骤、标签页等结构化内容。

这些能力将帮助我们用更直观的方式讲解引擎功能和完整开发流程。

详情请参见《文档使用说明》 第 4 节「文档反馈与修改」。

新版系统统一了文档路径、图片资源、目录生成和构建规则。未完成的草稿会从正式构建中剔除;仍需保留访问地址的编辑中内容会显示明确提示,并从目录和搜索中隐藏。

在发布前,系统还会检查站内链接、图片、脚本、样式和页面锚点,尽量避免出现图片丢失、链接失效或线上路径错误等问题。

旧版文档中的有效内容已经迁移到新版系统。由于目录结构和页面地址经过整理,部分旧链接可能会发生变化。如果通过收藏夹或搜索引擎打开旧地址后无法访问,建议进入新版文档首页,通过搜索功能重新定位内容。

在迁移和持续整理期间,个别系列文档可能会显示“正在编辑中”的提示。这表示该页面可以提前查阅,但内容仍会继续补充和校对。

文档系统的重构只是新的开始。后续我们会继续补充入门教程、实战案例、功能说明和迁移指南,并持续优化搜索与阅读体验。

如果你在使用过程中发现内容错误、链接失效、图片缺失,或者希望补充某个主题,欢迎通过 LayaAir 中文文档 GitHub 仓库提交 Issue 或 Pull Request,也可以联系 LayaAir 官方客服反馈。

感谢大家一直以来对 LayaAir 的关注与支持,希望新版文档能让每一位开发者更快找到答案、更顺利地完成项目。

LayaAir 团队

本文更新于