Skip to content

feat(docs): 添加站点全文搜索功能#129

Merged
cc-hearts merged 1 commit into
antdv-next:mainfrom
zha-ji-tui:feat/doc-search
Jul 10, 2026
Merged

feat(docs): 添加站点全文搜索功能#129
cc-hearts merged 1 commit into
antdv-next:mainfrom
zha-ji-tui:feat/doc-search

Conversation

@zha-ji-tui

@zha-ji-tui zha-ji-tui commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

🤔 This is a ...

  • 🆕 New feature
  • 🌐 Internationalization
  • 📝 Site / documentation improvement

🔗 Related Issues

close #128

💡 Background and Solution

当前文档站点缺少跨页面全文搜索能力,用户无法在站内搜索文档内容 / 组件 / API。参考 antdv-next 主库的 flexsearch 方案移植,适配 antdv-next-x 的路由规则(英文 -en 后缀)。

实现方案:

  • 索引生成:构建时通过 gen-search.mjs 扫描 src/pages/**/*.{zh-CN,en-US}.md,用 markdown-it 解析 frontmatter/headers/title,按 H2/H3 切分 section,flexsearch Document 索引导出 JSON 到 public/search.{cn,en}.json
  • 运行时检索:DocSearch 组件按当前 locale 懒加载对应索引,支持结果高亮、键盘上下导航、防抖、点击外部关闭、按 section 分组
  • 交互:默认只显示搜索图标,点击展开输入框(CSS transition 动画),Esc / 点击外部(内容为空)折叠
  • 集成:桌面端搜索框置于导航栏最左侧,移动端在 header 条和 drawer 内均提供搜索入口

📝 Change Log

Language Changelog
🇺🇸 English Add full-text search for docs site
🇨🇳 Chinese 文档站点新增全文搜索功能

- 新增 gen-search.mjs 构建时索引生成脚本
- 新增 DocSearch 组件(展开收起动画、键盘导航、高亮)
- Header 集成搜索框(桌面端导航栏 / 移动端 drawer)
- 添加 flexsearch 依赖
- 添加搜索 i18n 中英文文案
- Header 显示 @antdv-next/x 版本号
- 构建脚本 build 前自动生成搜索索引
@cc-hearts cc-hearts merged commit 4f8f595 into antdv-next:main Jul 10, 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