Docs 知识库
带目录树、本页目录与 ⌘K 检索的帮助中心阅读器
用法
三栏知识库
进入视口后文章自动滚到两个章节,你一动就停下;⌘K 搜索文章与章节。
示例加载中...
概述
Tuff 的三栏帮助中心;主推文章「插件权限说明」取自真实的权限注册表,其余为示例内容。
- 首次进入视口时,文章自动滚到「风险等级」与「安装时的授权选择」后停下;点击、按键、滚轮或触摸即结束,减少动态效果时直接停在后一节。
- 演示只滚文章自己的滚动容器,不动页面,也不移动焦点。
- 本页目录从 Markdown 源码解析,按顺序对应渲染出的标题;TxMarkdownView 的标题没有 id,模板也不加。
- 点目录项平滑滚到该节并保持高亮,直到你自己滚动文章。
- 正文链接在外层统一拦截:
#kb:链接在模板内打开文章;外链、中键与 ⌘ 点击只提示宿主会打开什么。 - 栏内(640–959px)本页目录收进工具行的下拉菜单;展开后为三栏;窄于 640px 时目录树变为左侧滑出的面板。
- ⌘K 绑在模板根节点,只在焦点位于模板内时生效;关闭面板后焦点回到搜索按钮。
自定义
- 接入真实文档时,大纲继续从源码解析;改用会生成标题 id 的渲染器前,先确认页面上没有脚本按 id 滚动整页。
- 需要代码高亮时,整篇改用 TxStreamMarkdown(非流式);正文里混用多个渲染器会让标题序号对不上。
- 文章多时,⌘K 改为按输入远程检索,章节只收录二级标题。
- 反馈接口记录文章 id、所选原因与文章版本号。
相关组件
| 区域 | 组件 | 作用 |
|---|---|---|
| 顶栏 | TxKbd、TxCommandPalette | ⌘K 搜索文章与章节 |
| 目录 | TxSearchInput、TxTree、TxBadge | 可筛选、可折叠的目录树 |
| 工具行 | TxBreadcrumb、TxDropdownMenu、TxProgressBar | 面包屑、目录与阅读进度 |
| 正文 | TxMarkdownView、TxAvatar | 正文、贡献者与更新时间 |
| 文章反馈 | TxFlatRadio、TxCheckbox、TxTextarea、TxButton | 有帮助 / 没帮助与原因 |
| 上一篇 / 下一篇、相关文章 | TxCardItem | 相邻与相关文章 |
| 本页目录(展开后) | 手写列表 + useIndicatorBox | 跟随滚动高亮当前章节 |
| 结果提示 | TxToastPanel | 外链、编辑与反馈的结果 |