Skip to content

feat: migrate help center to Outline and enable Typesense search - #7

Merged
nonepointer666 merged 13 commits into
nonepointer666:mainfrom
cyssayyes-source:feat/enable-typesense
Sep 11, 2026
Merged

nonepointer666 merged 13 commits into
nonepointer666:mainfrom
cyssayyes-source:feat/enable-typesense

Conversation

@cyssayyes-source

Copy link
Copy Markdown
Contributor

变更说明

  • 将生产内容源迁移到 Outline,并保留 legacy 文档用于无密钥的 PR 校验和本地构建
  • 接入 Typesense 文档搜索、中文分词、同义词、章节索引与相关性排序
  • 在首页和搜索页增加共享的即时搜索下拉,支持键盘、中文输入法、请求取消和轻量本地降级
  • 调整 GitHub Actions,使构建产物与 Typesense 索引使用同一份内容快照
  • 保留原有降级:未配置 Typesense host 或 admin key 时跳过远端索引同步,站点继续部署并使用本地搜索

部署配置

合并后生产 Outline 构建需要 OUTLINE_API_TOKEN,并需要可访问 Outline 的 self-hosted runner。

Typesense 为可选增强,当前 workflow 从 Repository Secrets 读取:

  • TYPESENSE_HOST
  • TYPESENSE_COLLECTION
  • TYPESENSE_SEARCH_API_KEY
  • TYPESENSE_ADMIN_API_KEY

未配置 Typesense 时不会阻断部署。Search-only key 可以进入浏览器构建;Admin key 仅供 CI 同步索引使用,不能暴露给前端。

验证

  • npm test:49 项通过
  • npm run typecheck:通过
  • npm run build:site:通过

构建仍会报告仓库原有的部分文档锚点和控制字符警告,但构建成功。

@nonepointer666
nonepointer666 merged commit 2039cbf into nonepointer666:main Sep 11, 2026
4 checks 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