Skip to content

Feat/outline document page types - #12

Merged
nonepointer666 merged 2 commits into
nonepointer666:mainfrom
cyssayyes-source:feat/outline-document-page-types
Sep 16, 2026
Merged

nonepointer666 merged 2 commits into
nonepointer666:mainfrom
cyssayyes-source:feat/outline-document-page-types

Conversation

@cyssayyes-source

Copy link
Copy Markdown
Contributor

背景

Outline 的文档层级与文档是否包含有效正文是两个独立维度。

此前如果仅按叶子节点判断页面是否展示或参与搜索,会出现以下问题:

  • 只包含子文档链接的父文档在帮助中心中显示为空白页面
  • 同时拥有正文和子文档的父文档可能被错误排除
  • 纯目录页的链接文字会被当作正文摘要,导致搜索结果重复显示标题

本次改动将文档层级与内容属性解耦,并针对不同页面类型分别处理展示和搜索行为。

主要改动

Outline 页面分类

同步阶段将文档划分为四种类型:

  • content:包含有效正文,无子文档
  • hybrid:包含有效正文,同时拥有子文档
  • directory:没有有效正文,但拥有子文档
  • empty:没有有效正文,也没有子文档

目录链接、标题、空行、分隔线和纯媒体内容不会被误判为有效正文。

页面展示

  • 所有 Outline 文档继续保留在侧栏导航中
  • 纯目录页显示直接子文档导航,不再展示空白正文
  • 混合页同时展示正文和子文档导航
  • 空文档显示明确的暂无正文状态
  • 子文档导航根据页面类型展示文件或目录图标

搜索索引

  • content、hybrid 和 directory 页面进入搜索索引
  • empty 页面不进入搜索索引
  • 搜索记录和 Typesense Schema 新增 page_type 字段
  • 纯目录页的搜索摘要固定显示“目录页”
  • 标题命中时隐藏重复的文档标题行,并兼容空格等格式差异
  • 小标题命中时保留的文档标题使用加粗样式

文档与测试

  • README 增加页面分类和搜索规则说明
  • 增加页面分类、目录内容识别、子文档生成和搜索规则测试

验证结果

  • npm test:62/62 通过
  • npm run typecheck:通过
  • npm run build:outline:通过
  • 校验 1077 条唯一文档路由
  • 生成 10649 条搜索记录和 1066 条搜索建议
  • 已使用本地 Typesense 实际验证目录页搜索、标题去重和文档标题加粗效果

备注

生产构建成功。构建过程中仍会报告少量来自现有 Outline 内容的 broken anchor 警告,本次改动未新增相关链接。

@nonepointer666
nonepointer666 merged commit 81a7cc3 into nonepointer666:main Sep 16, 2026
1 check passed
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.

2 participants