Skip to content

feat(docs): redesign documentation and restore idle offline caching - #414

Closed
chaxus wants to merge 6 commits into
mainfrom
feat/docs-builder-offline-redesign
Closed

chaxus wants to merge 6 commits into
mainfrom
feat/docs-builder-offline-redesign

Conversation

@chaxus

@chaxus chaxus commented Oct 1, 2026 •

Copy link
Copy Markdown
Owner

重新设计 docs 首页和文档阅读界面:以暖白、深墨与陶土色建立统一视觉,首页将组件试用、安装和库目录组织为清晰的浏览路径;文档统一导航、面包屑、正文、示例和搜索布局。此 PR 同时包含静态构建器迁移、增量构建修复与后台离线缓存恢复。

  • 组件试用区提供按钮、进度和选择三个示例,支持禁用、进度调节、选择状态反馈、当前示例重置和动态源码复制;方向键、Home/End 与 RTL 切换可用,八种语言共享交互文案。复制反馈处理连续操作与失败,未加载脚本时只展示可用的静态示例与原生代码展开。
  • 组件预览新增陶土、苔绿、墨色三套配色,切换不改变全站主题或当前示例。库目录支持组件 / 工具分类与关键词组合筛选,提供无结果状态;新增控件覆盖八种语言,无脚本时隐藏交互控件并保留全部内容。
  • 全站导航、文档面包屑、正文排版、代码示例、表格与搜索界面统一视觉;适配明暗主题、移动端及减少动画偏好。修复侧栏 sticky 定位被 inset-block 覆盖的问题。
  • 首页快速上手分离终端安装与有效 JavaScript,引入 ranui/style,提供与显示源码一致的两段复制操作;无脚本时隐藏复制按钮。
  • 阅读轨道对长文进行全文节点采样,保留首尾;按实际时间推进动画,实时响应减少动画偏好和窄屏变化,减少重复 DOM 写入。
  • 目录增加可显式切换的阅读轨道:文章默认轨道、API 默认文字目录,指针靠近或键盘聚焦恢复链接,SVG 显示章节与进度;减少动画时直接更新,切换不移动正文,无脚本时保留原生目录。
  • 文档目录同时更新手机与桌面的当前章节及 aria-current;通过二分定位处理快速滚动、锚点跳转和内容高度变化。代码复制提供独立的 44px 工具栏,连续操作的反馈以最新一次为准。
  • 页面、组件、SEO、Markdown 容器和搜索结果统一使用 @alixex/ranview/static,保留多语言 DOM 与脚本语义,安全转义文本和属性;示例源码保持原格式。
  • SW 先安装必要资源,再通过页面空闲调度按每批 20 个资源、最多 2 个并发下载全部站内文档、搜索索引和静态资源。持久化进度、重试超时或失败请求,复用内容未变的资源,完整替换后才清理旧版本缓存。
  • 补充缺少空闲调度、网络信息、Response.json、AbortController 等 API 时的降级处理;存储受限时正常在线阅读。页面隐藏、断网、省流量和 2G 时暂停后台批次。
  • Markdown 修改复用已有构建资源,清理删除或重命名页面;补充根目录文档、public/assets 和构建配置监听,并让 POSIX 构建脚本遇错退出。

验证:

  • 本次重新设计:docs 73 项测试、pnpm tsc、pnpm verify:design、完整构建与 1,401 页校验通过。Chrome 实测配色、示例调节与重置、目录组合筛选、搜索及八种语言;320 / 375 / 768 / 1440px 无横向溢出,明暗主题与禁用 JavaScript 展示已检查。
  • 独立代码审查完成,修复无脚本控件显示的 CSS 级联问题,无未解决的阻塞问题。
  • pnpm run lint、pnpm run verify:docs、pnpm run verify:design 通过。
  • 仓库全量测试已执行;最终 docs 73 项、ranpress 81 项测试通过。八种语言标签与结构、docs 设计规则检查通过。
  • docs 完整构建与 1,401 页链接、锚点、canonical、资源和 sitemap 校验通过;共享构建引擎的 site 构建与校验通过。
  • Chromium、Firefox、WebKit 实测完成 1,958 项资源缓存后,未访问过的文档与搜索在离线时可用;新版首页的动态源码、复制、禁用、重置、选择和键盘操作在三种引擎中通过,移动端 RTL 无溢出;桌面、移动端、明暗主题与禁用脚本的降级展示均已检查;本轮三种引擎再次验证双目录同步、源码复制、移动端目录收起与 RTL;最新一轮验证导航容器一致、轨道切换、键盘展开、减少动画、首页手机菜单与固定侧栏。

完整离线覆盖在后台下载完成后生效,受浏览器存储配额限制。缺少 requestIdleCallback 时使用输入避让和延迟调度,属于近似空闲执行。为避免并行更新误删新资源,共享缓存中的历史资源暂时保留。

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Deploying ran with  Cloudflare Pages  Cloudflare Pages

Latest commit: d8d971d
Status: ✅  Deploy successful!
Preview URL: https://4631f3ed.ran-4ty.pages.dev
Branch Preview URL: https://feat-docs-builder-offline-re.ran-4ty.pages.dev

View logs

@chaxus chaxus closed this Oct 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant