Add search

未关闭
#292 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
javascript

调研方向

Start by reviewing the docsite redesign and the generated _site output, then evaluate how elasticlunr could index the

, <title>, and <h*> content. Define the search-result presentation and keyboard behavior from the examples mentioned, including how API functions should be weighted. Done means the docsite has a usable custom search without the removed DuckDuckGo bar.

由索引模型根据 Issue 内容生成。

描述

enhancement

In the docsite redesign we removed the duckduckgo search bar. The plan is to replace it with a custom search bar.

Current ideas for this are roughly

  • use something like elasticlunr
  • produce an index by scanning the generated _site, focussing the search on the <main>, <title>, and <h*> tags with more weight on <h*> and <title>
  • it would be nice to recognise API functions and give them more weight so that it is possible to go to them quickly. Not sure how much work that would be.
  • write js to present search results in a reasonably nice form (examples would be mdbook or the search on the tailwindcss.com site)
  • make sure search can be operated by keyboard without mouse
主要语言
HTML
星标
19
派生
67
平均合并
17 小时 11 分钟
30 天内合并 PR
5

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

seL4/docs 的其他 Issue

查看 seL4/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。